Invoke (Apache Commons SCXML 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.scxml2.model.Action
- - org.apache.commons.scxml2.model.PayloadProvider
  - - org.apache.commons.scxml2.model.ParamsContainer
    - - org.apache.commons.scxml2.model.NamelistHolder
      - org.apache.commons.scxml2.model.Invoke

All Implemented Interfaces:

Serializable, ContentContainer, NamespacePrefixesHolder, PathResolverHolder
```
public class Invoke
extends NamelistHolder
implements PathResolverHolder, ContentContainer
```
The class in this SCXML object model that corresponds to the <invoke> SCXML element.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Invoke()

Constructors
Constructor and Description
`Invoke()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)` Enforce identity equality only
`void`	`execute(ActionExecutionContext axctx)` Execute this action instance.
`Boolean`	`getAutoForward()`
`Content`	`getContent()` Returns the content
`String`	`getCurrentSCXMLExecutionContextKey()`
`Finalize`	`getFinalize()` Get the Finalize for this Invoke.
`String`	`getId()` Get the identifier for this invoke (may be null).
`String`	`getIdlocation()`
`EnterableState`	`getParentEnterableState()` Get the parent EnterableState.
`PathResolver`	`getPathResolver()` Get the `PathResolver`.
`String`	`getSrc()` Get the URL for the external service.
`String`	`getSrcexpr()` Get the expression that evaluates to the source URL for the external service.
`String`	`getType()` Get the type for this <invoke> element.
`String`	`getTypeexpr()`
`int`	`hashCode()` Enforce returning identity based hascode
`boolean`	`isAutoForward()`
`void`	`setAutoForward(Boolean autoForward)` Set the flag indicating whether to forward events to the invoked process.
`void`	`setContent(Content content)` Sets the content
`void`	`setFinalize(Finalize finalize)` Set the Finalize for this Invoke.
`void`	`setId(String id)` Set the identifier for this invoke.
`void`	`setIdlocation(String idlocation)` Set the idlocation expression
`void`	`setParentEnterableState(EnterableState parent)` Set the parent EnterableState.
`void`	`setPathResolver(PathResolver pathResolver)` Set the `PathResolver`.
`void`	`setSrc(String src)` Set the URL for the external service.
`void`	`setSrcexpr(String srcexpr)` Set the expression that evaluates to the source URL for the external service.
`void`	`setType(String type)` Set the type for this <invoke> element.
`void`	`setTypeexpr(String typeexpr)` Sets the type expression

Methods inherited from class org.apache.commons.scxml2.model.NamelistHolder
addNamelistDataToPayload, getNamelist, setNamelist

Methods inherited from class org.apache.commons.scxml2.model.ParamsContainer
addParamsToPayload, getParams

Methods inherited from class org.apache.commons.scxml2.model.PayloadProvider
addToPayload, clonePayloadValue, makeEventPayload

Methods inherited from class org.apache.commons.scxml2.model.Action
getNamespaces, getNamespacesKey, getParent, getTextContentIfNodeResult, setNamespaces, setParent

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

- Constructor Detail
  - Invoke
```
public Invoke()
```
- Method Detail
  - getId
```
public final String getId()
```
    Get the identifier for this invoke (may be null).
    
    Returns:
    Returns the id.
  - setId
```
public final void setId(String id)
```
    Set the identifier for this invoke.
    
    Parameters:
    id - The id to set.
  - getIdlocation
```
public String getIdlocation()
```
    Returns:
    the idlocation
  - setIdlocation
```
public void setIdlocation(String idlocation)
```
    Set the idlocation expression
    
    Parameters:
    idlocation - The idlocation expression
  - getType
```
public final String getType()
```
    Get the type for this <invoke> element.
    
    Returns:
    String Returns the type.
  - setType
```
public final void setType(String type)
```
    Set the type for this <invoke> element.
    
    Parameters:
    type - The type to set.
  - getTypeexpr
```
public String getTypeexpr()
```
    Returns:
    The type expression
  - setTypeexpr
```
public void setTypeexpr(String typeexpr)
```
    Sets the type expression
    
    Parameters:
    typeexpr - The type expression to set
  - getSrc
```
public final String getSrc()
```
    Get the URL for the external service.
    
    Returns:
    String The URL.
  - setSrc
```
public final void setSrc(String src)
```
    Set the URL for the external service.
    
    Parameters:
    src - The source URL.
  - getSrcexpr
```
public final String getSrcexpr()
```
    Get the expression that evaluates to the source URL for the external service.
    
    Returns:
    String The source expression.
  - setSrcexpr
```
public final void setSrcexpr(String srcexpr)
```
    Set the expression that evaluates to the source URL for the external service.
    
    Parameters:
    srcexpr - The source expression.
  - isAutoForward
```
public final boolean isAutoForward()
```
    Returns:
    Returns true if all external events should be forwarded to the invoked process.
  - getAutoForward
```
public final Boolean getAutoForward()
```
    Returns:
    Returns the flag indicating whether to forward events to the invoked process.
  - setAutoForward
```
public final void setAutoForward(Boolean autoForward)
```
    Set the flag indicating whether to forward events to the invoked process.
    
    Parameters:
    autoForward - the flag
  - getFinalize
```
public final Finalize getFinalize()
```
    Get the Finalize for this Invoke.
    
    Returns:
    Finalize The Finalize for this Invoke.
  - setFinalize
```
public final void setFinalize(Finalize finalize)
```
    Set the Finalize for this Invoke.
    
    Parameters:
    finalize - The Finalize for this Invoke.
  - getPathResolver
```
public PathResolver getPathResolver()
```
    Get the PathResolver.
    
    Specified by:
    
    getPathResolver in interface PathResolverHolder
    
    Returns:
    Returns the pathResolver.
  - setPathResolver
```
public void setPathResolver(PathResolver pathResolver)
```
    Set the PathResolver.
    
    Specified by:
    
    setPathResolver in interface PathResolverHolder
    
    Parameters:
    pathResolver - The pathResolver to set.
  - equals
```
public final boolean equals(Object other)
```
    Enforce identity equality only
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    other - other object to compare with
    
    Returns:
    this == other
  - hashCode
```
public final int hashCode()
```
    Enforce returning identity based hascode
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    System.identityHashCode(this)
  - getContent
```
public Content getContent()
```
    Returns the content
    
    Specified by:
    
    getContent in interface ContentContainer
    
    Returns:
    the content
  - getCurrentSCXMLExecutionContextKey
```
public String getCurrentSCXMLExecutionContextKey()
```
    Returns:
    The local context variable name under which the current SCXMLExecutionContext is provided to the Invoke
  - setContent
```
public void setContent(Content content)
```
    Sets the content
    
    Specified by:
    
    setContent in interface ContentContainer
    
    Parameters:
    content - the content to set
  - getParentEnterableState
```
public EnterableState getParentEnterableState()
```
    Get the parent EnterableState.
    
    Overrides:
    
    getParentEnterableState in class Action
    
    Returns:
    Returns the parent state
  - setParentEnterableState
```
public void setParentEnterableState(EnterableState parent)
```
    Set the parent EnterableState.
    
    Parameters:
    parent - The parent state to set
  - execute
```
public void execute(ActionExecutionContext axctx)
             throws ModelException
```
    Description copied from class: Action
    
    Execute this action instance.
    
    Specified by:
    
    execute in class Action
    
    Parameters:
    axctx - The ActionExecutionContext for this execution instance
    
    Throws:
    
    ModelException - If the execution causes the model to enter a non-deterministic state.

Class Invoke

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.scxml2.model.NamelistHolder

Methods inherited from class org.apache.commons.scxml2.model.ParamsContainer

Methods inherited from class org.apache.commons.scxml2.model.PayloadProvider

Methods inherited from class org.apache.commons.scxml2.model.Action

Methods inherited from class java.lang.Object

Constructor Detail

Invoke

Method Detail

getId

setId

getIdlocation

setIdlocation

getType

setType

getTypeexpr

setTypeexpr

getSrc

setSrc

getSrcexpr

setSrcexpr

isAutoForward

getAutoForward

setAutoForward

getFinalize

setFinalize

getPathResolver

setPathResolver

equals

hashCode

getContent

getCurrentSCXMLExecutionContextKey

setContent

getParentEnterableState

setParentEnterableState

execute