com.oakgrovesystems.reactor.requests
Class Start

java.lang.Object
  |
  +--com.oakgrovesystems.reactor.requests.ReactorRequest
        |
        +--com.oakgrovesystems.reactor.requests.Start
All Implemented Interfaces:
java.io.Serializable

public class Start
extends ReactorRequest

A request to start a Process instance. Fulfillment of this request may cause conditions of other Processes to become true, triggering a cascade of changes. Fulfillment of this request also fires a 'ProcessStarted' event which may trigger execution of one or more Policies, which themselves may trigger cascading changes to the Process Mediation Objects.

See Also:
Serialized Form

Field Summary
static java.lang.String ID_PARM_NAME
          The name of the request parameter that is the id of the Process to be started.
static java.lang.String LABEL_PATH_PARM_NAME
          The name of the request parameter that is the label path of the Process to be started.
static java.lang.String REQUEST_TYPE
          The request type of Start requests.
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
Start()
          Creates a Start request without specifying the authentication token to use to make the request.
Start(java.lang.String authToken)
          Creates a Start request that will use the specified authentication token
 
Method Summary
 com.oakgrovesystems.reactor.ReactorObjectId getProcessId()
          returns the id of the Process to start
 com.oakgrovesystems.reactor.LabelPath getProcessLabelPath()
          returns the label path of the Process to start
protected  java.util.List paramsToXML()
          Returns a List of Elements representing the parameters of the request
protected  void parseParameters(org.jdom.Element params, com.oakgrovesystems.reactor.LabelPathToIdMapper mapper)
          Configures the parameters from the XML representation
protected  com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
           
 void setProcessId(com.oakgrovesystems.reactor.ReactorObjectId id)
          Specifies the id of the Process to start.
 void setProcessLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
          Specifies the label path of the Process to start.
 
Methods inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
configureFromXML, configureFromXML, createResponseXML, createResponseXML, createReturnValuesElem, createRtnValXML, getAuthToken, getLabelPath, getObjectId, getParameter, getParameter, getParameterNames, getRequestType, makeAuthTokenXML, makeObjectElement, makeOperandElement, makePolicyElement, makeProcessElement, makeReferenceElement, makeStatusElement, parseResponse, send, sendAsXML, sendViaHttp, setAuthToken, setParameter, setRequestType, toString, toXML
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID_PARM_NAME

public static final java.lang.String ID_PARM_NAME
The name of the request parameter that is the id of the Process to be started.

See Also:
Constant Field Values

LABEL_PATH_PARM_NAME

public static final java.lang.String LABEL_PATH_PARM_NAME
The name of the request parameter that is the label path of the Process to be started.

See Also:
Constant Field Values

REQUEST_TYPE

public static final java.lang.String REQUEST_TYPE
The request type of Start requests. Used as a parameter to setRequestType() in the instance initializer.

See Also:
Constant Field Values
Constructor Detail

Start

public Start()
Creates a Start request without specifying the authentication token to use to make the request. setAuthToken() must be called before the request can be sent successfully.


Start

public Start(java.lang.String authToken)
Creates a Start request that will use the specified authentication token

Parameters:
authToken - the authentication token to use to make the request
Method Detail

setProcessId

public void setProcessId(com.oakgrovesystems.reactor.ReactorObjectId id)
Specifies the id of the Process to start. Calling this method with a non-null parameter has the side effect of calling setLabelPath with a null parameter.

Parameters:
id - the id of the Process to start

getProcessId

public com.oakgrovesystems.reactor.ReactorObjectId getProcessId()
returns the id of the Process to start

Returns:
the id of the Process to start

setProcessLabelPath

public void setProcessLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
Specifies the label path of the Process to start. Calling this method with a non-null parameter has the side effect of calling setId with a null parameter.

Parameters:
lp - the label path of the Process to start

getProcessLabelPath

public com.oakgrovesystems.reactor.LabelPath getProcessLabelPath()
returns the label path of the Process to start

Returns:
the label path of the Process to start

parseParameters

protected void parseParameters(org.jdom.Element params,
                               com.oakgrovesystems.reactor.LabelPathToIdMapper mapper)
                        throws FailedRequestException
Description copied from class: ReactorRequest
Configures the parameters from the XML representation

Specified by:
parseParameters in class ReactorRequest
Parameters:
params - the 'parameters' Element of the request
Throws:
FailedRequestException - if the parameters can't be configured from the XML.

paramsToXML

protected java.util.List paramsToXML()
                              throws FailedRequestException
Description copied from class: ReactorRequest
Returns a List of Elements representing the parameters of the request

Specified by:
paramsToXML in class ReactorRequest
Returns:
a List of Elements representing the parameters of the request
FailedRequestException

parseReturnValues

protected com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
                                                                 throws FailedRequestException
Specified by:
parseReturnValues in class ReactorRequest
FailedRequestException


Copyright (c) 1999-2004 Oak Grove Systems. All Rights Reserved.