org.jboss.dtf.testframework.coordinator.actions
Class TerminateAction

java.lang.Object
  org.jboss.dtf.testframework.coordinator.Action
      org.jboss.dtf.testframework.coordinator.actions.TerminateAction

Direct Known Subclasses:

WaitForAction

public class TerminateAction
extends Action

Field Summary

protected java.lang.String	_runtimeId
static java.lang.String	TERMINATE_TASK_NAME

Fields inherited from class org.jboss.dtf.testframework.coordinator.Action

_actionType, LOCATION_ALL, LOCATION_DEPENDENT, LOCATION_INDEPENDENT, LOCATION_SPECIFIC, LOCATION_STRINGS, PERFORM_TASK, START_TASK, TERMINATE_TASK, WAIT_FOR_TASK

Constructor Summary

TerminateAction(java.lang.String runtimeId)

Method Summary

java.lang.String	getAssociatedNameList() Retrieves the name list for this action, throws an exception if no name list is associated with this action.
java.lang.String	getAssociatedRuntimeTaskId() Retrieves the associated runtime task id., if one doesn't exist an exception is thrown.
java.lang.String	getAssociatedTaskId() Retrieves the task id.
java.lang.String[]	getJVMParameterList() Retrieves the parameters to be passed to the JVM that executes this action, if no parameters are associated with this action then an exception is thrown.
java.lang.String	getLocation() Retrieves the location value associated with this action, if the action type doesn't have an associated location an exception is thrown.
java.lang.String[]	getParameterList() Retrieves the parameters to be passed to this action, if no parameters are associated with this action then an exception is thrown.
static TerminateAction	getTerminateAction(Element actionElement)
Element	serializeToXML() Create an XML element which represents this action
void	setAssociatedRuntimeTaskId(java.lang.String runtimeId)
java.lang.String	toString()

Methods inherited from class org.jboss.dtf.testframework.coordinator.Action

getLocationType, getType

Methods inherited from class java.lang.Object

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

Field Detail

TERMINATE_TASK_NAME

public static final java.lang.String TERMINATE_TASK_NAME

See Also:

Constant Field Values

_runtimeId

protected java.lang.String _runtimeId

Constructor Detail

TerminateAction

public TerminateAction(java.lang.String runtimeId)

Method Detail

getAssociatedTaskId

public java.lang.String getAssociatedTaskId()
                                     throws NoAssociatedData

Retrieves the task id. associated with this action, if the action type doesn't have an associated task id. an exception is thrown.

Specified by:

getAssociatedTaskId in class Action

Returns:

The associated task id

Throws:

NoAssociatedData - Thrown if there is no associated task id.

getLocation

public java.lang.String getLocation()
                             throws NoAssociatedData

Retrieves the location value associated with this action, if the action type doesn't have an associated location an exception is thrown.

Specified by:

getLocation in class Action

Returns:

The associated location value

Throws:

NoAssociatedData - Thrown if there is no associated task id.

getParameterList

public java.lang.String[] getParameterList()
                                    throws NoAssociatedData

Retrieves the parameters to be passed to this action, if no parameters are associated with this action then an exception is thrown.

Specified by:

getParameterList in class Action

Returns:

The parameters to be passed to this action

Throws:

NoAssociatedData - Thrown if there are no parameters for this action.

getJVMParameterList

public java.lang.String[] getJVMParameterList()
                                       throws NoAssociatedData

Retrieves the parameters to be passed to the JVM that executes this action, if no parameters are associated with this action then an exception is thrown.

Specified by:

getJVMParameterList in class Action

Returns:

The parameters to be passed to the JVM

Throws:

NoAssociatedData - Thrown if there are no parameters to pass to the JVM.

getAssociatedRuntimeTaskId

public java.lang.String getAssociatedRuntimeTaskId()
                                            throws NoAssociatedData

Retrieves the associated runtime task id., if one doesn't exist an exception is thrown.

Specified by:

getAssociatedRuntimeTaskId in class Action

Returns:

The associated runtime task id.

Throws:

NoAssociatedData - Thrown if there is no associated runtime task id.

setAssociatedRuntimeTaskId

public void setAssociatedRuntimeTaskId(java.lang.String runtimeId)

getAssociatedNameList

public java.lang.String getAssociatedNameList()
                                       throws NoAssociatedData

Retrieves the name list for this action, throws an exception if no name list is associated with this action.

Specified by:

getAssociatedNameList in class Action

Returns:

The name list associated with this action.

Throws:

NoAssociatedData - Thrown if there is no associated name list.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

serializeToXML

public Element serializeToXML()
                       throws NoAssociatedData

Create an XML element which represents this action

Specified by:

serializeToXML in class Action

Returns:

The XML element representing this action.

Throws:

NoAssociatedData

getTerminateAction

public static TerminateAction getTerminateAction(Element actionElement)