|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.oakgrovesystems.reactor.requests.ReactorRequest | +--com.oakgrovesystems.reactor.requests.AddStatus
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.
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 |
public static final java.lang.String PROCESS_ID_PARM_NAME
public static final java.lang.String PROCESS_LP_PARM_NAME
public static final java.lang.String STATUS_ID_PARM_NAME
public static final java.lang.String STATUS_LP_PARM_NAME
public static final java.lang.String REQUEST_TYPE
Constructor Detail |
public AddStatus()
public AddStatus(java.lang.String authToken)
authToken
- the authentication token to use to make the requestMethod Detail |
public void setProcessId(com.oakgrovesystems.reactor.ReactorObjectId procId)
procId
- The id of the Process to which a Status should be added.public com.oakgrovesystems.reactor.ReactorObjectId getProcessId()
public void setProcessLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
lp
- The label path of the Process to which a Status should be added.public com.oakgrovesystems.reactor.LabelPath getProcessLabelPath()
public void setStatusId(com.oakgrovesystems.reactor.ReactorObjectId statId)
public com.oakgrovesystems.reactor.ReactorObjectId getStatusId()
public void setStatusLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
lp
- the LabelPath of the Status to add.public com.oakgrovesystems.reactor.LabelPath getStatusLabelPath()
protected void parseParameters(org.jdom.Element params, com.oakgrovesystems.reactor.LabelPathToIdMapper mapper) throws FailedRequestException
ReactorRequest
parseParameters
in class ReactorRequest
params
- the 'parameters' Element of the request
FailedRequestException
- if the parameters can't be configured from the XML.protected java.util.List paramsToXML() throws FailedRequestException
ReactorRequest
paramsToXML
in class ReactorRequest
FailedRequestException
protected com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues) throws FailedRequestException
parseReturnValues
in class ReactorRequest
FailedRequestException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |