org.apache.commons.scxml.model
Class Send

java.lang.Object
  org.apache.commons.scxml.model.Action
      org.apache.commons.scxml.model.Send

All Implemented Interfaces:

java.io.Serializable, ExternalContent, NamespacePrefixesHolder

public class Send
extends Action
implements ExternalContent

The class in this SCXML object model that corresponds to the <send> SCXML element.

See Also:

Serialized Form

Constructor Summary

Send()
Constructor.

Method Summary

void	execute(EventDispatcher evtDispatcher, ErrorReporter errRep, SCInstance scInstance, org.apache.commons.logging.Log appLog, java.util.Collection derivedEvents) Execute this action instance.
java.lang.String	getDelay() Get the delay.
java.lang.String	getEvent() Set the event to send.
java.util.List	getExternalNodes() Get the list of external namespaced child nodes.
java.lang.String	getHints() Get the hints for this <send> element.
java.lang.String	getNamelist() Get the namelist.
java.lang.String	getSendid() Get the identifier for this <send> element.
java.lang.String	getTarget() Get the target for this <send> element.
java.lang.String	getTargettype() Get the target type for this <send> element.
void	setDelay(java.lang.String delay) Set the delay.
void	setEvent(java.lang.String event) Get the event to send.
void	setExternalNodes(java.util.List externalNodes) Set the list of external namespaced child nodes.
void	setHints(java.lang.String hints) Set the hints for this <send> element.
void	setNamelist(java.lang.String namelist) Set the namelist.
void	setSendid(java.lang.String sendid) Set the identifier for this <send> element.
void	setTarget(java.lang.String target) Set the target for this <send> element.
void	setTargettype(java.lang.String targettype) Set the target type for this <send> element.

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

getNamespaces, getNamespacesKey, getParent, getParentState, setNamespaces, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Send

public Send()

Constructor.

Method Detail

getDelay

public final java.lang.String getDelay()

Get the delay.

Returns:

Returns the delay.

setDelay

public final void setDelay(java.lang.String delay)

Set the delay.

Parameters:

delay - The delay to set.

getExternalNodes

public final java.util.List getExternalNodes()

Get the list of external namespaced child nodes.

Specified by:

getExternalNodes in interface ExternalContent

Returns:

List Returns the list of externalnodes.

setExternalNodes

public final void setExternalNodes(java.util.List externalNodes)

Set the list of external namespaced child nodes.

Parameters:

externalNodes - The externalnode to set.

getHints

public final java.lang.String getHints()

Get the hints for this <send> element.

Returns:

String Returns the hints.

setHints

public final void setHints(java.lang.String hints)

Set the hints for this <send> element.

Parameters:

hints - The hints to set.

getNamelist

public final java.lang.String getNamelist()

Get the namelist.

Returns:

String Returns the namelist.

setNamelist

public final void setNamelist(java.lang.String namelist)

Set the namelist.

Parameters:

namelist - The namelist to set.

getSendid

public final java.lang.String getSendid()

Get the identifier for this <send> element.

Returns:

String Returns the sendid.

setSendid

public final void setSendid(java.lang.String sendid)

Set the identifier for this <send> element.

Parameters:

sendid - The sendid to set.

getTarget

public final java.lang.String getTarget()

Get the target for this <send> element.

Returns:

String Returns the target.

setTarget

public final void setTarget(java.lang.String target)

Set the target for this <send> element.

Parameters:

target - The target to set.

getTargettype

public final java.lang.String getTargettype()

Get the target type for this <send> element.

Returns:

String Returns the targettype.

setTargettype

public final void setTargettype(java.lang.String targettype)

Set the target type for this <send> element.

Parameters:

targettype - The targettype to set.

setEvent

public final void setEvent(java.lang.String event)

Get the event to send.

Parameters:

event - The event to set.

getEvent

public final java.lang.String getEvent()

Set the event to send.

Returns:

String Returns the event.

execute

public void execute(EventDispatcher evtDispatcher,
                    ErrorReporter errRep,
                    SCInstance scInstance,
                    org.apache.commons.logging.Log appLog,
                    java.util.Collection derivedEvents)
             throws ModelException,
                    SCXMLExpressionException

Execute this action instance.

Specified by:

execute in class Action

Parameters:

evtDispatcher - The EventDispatcher for this execution instance

errRep - The ErrorReporter to broadcast any errors during execution.

scInstance - The state machine execution instance information.

appLog - The application Log.

derivedEvents - The collection to which any internal events arising from the execution of this action must be added.

Throws:

ModelException - If the execution causes the model to enter a non-deterministic state.

SCXMLExpressionException - If the execution involves trying to evaluate an expression which is malformed.