com.oakgrovesystems.reactor.requests
Class AddStatus

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

public class AddStatus
extends ReactorRequest

A request to add a current status to a Process. 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 'ProcessStatusAddition' 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 PROCESS_ID_PARM_NAME
          The name of the request parameter that is the Process to which the Status should be added.
static java.lang.String PROCESS_LP_PARM_NAME
          The name of the request parameter that is the Process to which the Status should be added.
static java.lang.String REQUEST_TYPE
          The request type of AddStatus requests.
static java.lang.String STATUS_ID_PARM_NAME
          The name of the request parameter that is the Status to add.
static java.lang.String STATUS_LP_PARM_NAME
          The name of the request parameter that is the Status to add.
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
AddStatus()
          Creates a AddStatus request without specifying the authentication token to use to make the request.
AddStatus(java.lang.String authToken)
          Creates a AddStatus request that will use the specified authentication token
 
Method Summary
 com.oakgrovesystems.reactor.ReactorObjectId getProcessId()
          returns the id of the Process to which a Status should be added.
 com.oakgrovesystems.reactor.LabelPath getProcessLabelPath()
          returns the label path of the Process to which a Status should be added.
 com.oakgrovesystems.reactor.ReactorObjectId getStatusId()
          returns the id of the Status to add.
 com.oakgrovesystems.reactor.LabelPath getStatusLabelPath()
          returns the LabelPath of the Status to add.
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 procId)
          Specifies the id of the Process to which a Status should be added.
 void setProcessLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
          Specifies the label path of the Process to which a Status should be added.
 void setStatusId(com.oakgrovesystems.reactor.ReactorObjectId statId)
          Specifies the id of the Status to add.
 void setStatusLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
          Specifies the LabelPath of the Status to add.
 
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

PROCESS_ID_PARM_NAME

public static final java.lang.String PROCESS_ID_PARM_NAME
The name of the request parameter that is the Process to which the Status should be added.

See Also:
Constant Field Values

PROCESS_LP_PARM_NAME

public static final java.lang.String PROCESS_LP_PARM_NAME
The name of the request parameter that is the Process to which the Status should be added.

See Also:
Constant Field Values

STATUS_ID_PARM_NAME

public static final java.lang.String STATUS_ID_PARM_NAME
The name of the request parameter that is the Status to add.

See Also:
Constant Field Values

STATUS_LP_PARM_NAME

public static final java.lang.String STATUS_LP_PARM_NAME
The name of the request parameter that is the Status to add.

See Also:
Constant Field Values

REQUEST_TYPE

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

See Also:
Constant Field Values
Constructor Detail

AddStatus

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


AddStatus

public AddStatus(java.lang.String authToken)
Creates a AddStatus 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 procId)
Specifies the id of the Process to which a Status should be added. Calling this method with a non-null parameter has the side effect of calling setProcessLabelPath with a null parameter.

Parameters:
procId - The id of the Process to which a Status should be added.

getProcessId

public com.oakgrovesystems.reactor.ReactorObjectId getProcessId()
returns the id of the Process to which a Status should be added.

Returns:
the id of the Process to which a Status should be added.

setProcessLabelPath

public void setProcessLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
Specifies the label path of the Process to which a Status should be added. Calling this method with a non-null parameter has the side effect of calling setProcessId with a null parameter.

Parameters:
lp - The label path of the Process to which a Status should be added.

getProcessLabelPath

public com.oakgrovesystems.reactor.LabelPath getProcessLabelPath()
returns the label path of the Process to which a Status should be added.

Returns:
the label path of the Process to which a Status should be added.

setStatusId

public void setStatusId(com.oakgrovesystems.reactor.ReactorObjectId statId)
Specifies the id of the Status to add. Calling this method with a non-null parameter has the side effect of calling setStatusLabelPath with a null parameter.


getStatusId

public com.oakgrovesystems.reactor.ReactorObjectId getStatusId()
returns the id of the Status to add.

Returns:
the id of the Status to add.

setStatusLabelPath

public void setStatusLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
Specifies the LabelPath of the Status to add. Calling this method with a non-null parameter has the side effect of calling setStatusId with a null parameter.

Parameters:
lp - the LabelPath of the Status to add.

getStatusLabelPath

public com.oakgrovesystems.reactor.LabelPath getStatusLabelPath()
returns the LabelPath of the Status to add.

Returns:
the LabelPath of the Status to add.

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.