SimpleSCXMLInvoker (Apache Commons SCXML 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.scxml2.invoke.SimpleSCXMLInvoker

All Implemented Interfaces:

Serializable, Invoker
```
public class SimpleSCXMLInvoker
extends Object
implements Invoker, Serializable
```
A simple Invoker for SCXML documents. Invoked SCXML document may not contain external namespace elements, further invokes etc.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

SimpleSCXMLInvoker()

Constructors
Constructor and Description
`SimpleSCXMLInvoker()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cancel()` Cancel this invocation.
`SCXMLIOProcessor`	`getChildIOProcessor()` Get the child IO Processor to register for communication with the parent session.
`String`	`getInvokeId()` .
`void`	`invoke(String source, Map<String,Object> params)` Begin this invocation.
`void`	`parentEvent(TriggerEvent evt)` Forwards the event triggered on the parent state machine on to the invoked activity.
`void`	`setInvokeId(String invokeId)` Set the invoke ID provided by the parent state machine executor Implementations must use this ID for constructing the event name for the special "done" event (and optionally, for other event names as well).
`void`	`setParentSCXMLExecutor(SCXMLExecutor parentSCXMLExecutor)` Sets the parent SCXMLExecutor through which this Invoker is initiated

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleSCXMLInvoker
```
public SimpleSCXMLInvoker()
```
- Method Detail
  - getInvokeId
```
public String getInvokeId()
```
    .
    
    Specified by:
    
    getInvokeId in interface Invoker
    
    Returns:
    get the invoke ID provided by the parent state machine executor
  - setInvokeId
```
public void setInvokeId(String invokeId)
```
    Set the invoke ID provided by the parent state machine executor Implementations must use this ID for constructing the event name for the special "done" event (and optionally, for other event names as well)..
    
    Specified by:
    
    setInvokeId in interface Invoker
    
    Parameters:
    invokeId - The invoke ID provided by the parent state machine executor.
  - setParentSCXMLExecutor
```
public void setParentSCXMLExecutor(SCXMLExecutor parentSCXMLExecutor)
```
    Sets the parent SCXMLExecutor through which this Invoker is initiated.
    
    Specified by:
    
    setParentSCXMLExecutor in interface Invoker
    
    Parameters:
    parentSCXMLExecutor - the parent SCXMLExecutor
  - getChildIOProcessor
```
public SCXMLIOProcessor getChildIOProcessor()
```
    Get the child IO Processor to register for communication with the parent session..
    
    Specified by:
    
    getChildIOProcessor in interface Invoker
    
    Returns:
    Child IO Processor
  - invoke
```
public void invoke(String source,
          Map<String,Object> params)
            throws InvokerException
```
    Begin this invocation..
    
    Specified by:
    
    invoke in interface Invoker
    
    Parameters:
    source - The source URI of the activity being invoked.
    params - The <param> values
    
    Throws:
    
    InvokerException - In case there is a fatal problem with invoking the source.
  - parentEvent
```
public void parentEvent(TriggerEvent evt)
                 throws InvokerException
```
    Forwards the event triggered on the parent state machine on to the invoked activity..
    
    Specified by:
    
    parentEvent in interface Invoker
    
    Parameters:
    evt - an external event which triggered during the last time quantum
    
    Throws:
    
    InvokerException - In case there is a fatal problem with processing the events forwarded by the parent state machine.
  - cancel
```
public void cancel()
            throws InvokerException
```
    Cancel this invocation..
    
    Specified by:
    
    cancel in interface Invoker
    
    Throws:
    
    InvokerException - In case there is a fatal problem with canceling this invoke.

Class SimpleSCXMLInvoker

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleSCXMLInvoker

Method Detail

getInvokeId

setInvokeId

setParentSCXMLExecutor

getChildIOProcessor

invoke

parentEvent

cancel