|
|||||||||||
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.QueryRequest | +--com.oakgrovesystems.reactor.requests.QueryProcesses
A request for a Set of Process objects matching certain criteria. The possible criteria include:
Field Summary | |
static java.lang.String |
ACE_PROFILE_PARM_NAME
The name of the request parameter that is the ACE profile that must match an ACE in the ACL of a Process for it to be included in the result set |
static java.lang.String |
DEFINITION_PARM_NAME
The name of the request parameter that is whether or not a Process must be a definition to be included in the result set |
static java.lang.String |
INSTANCE_PARM_NAME
The name of the request parameter that is whether or not a Process must be an instance to be included in the result set |
static java.lang.String |
PROCESSES
The type of a query for a process subtree |
static java.lang.String |
REFERENCES_PARM_NAME
The name of the request parameter that is whether or not to return identifiers in the result set instead of the objects themselves |
static java.lang.String |
REQUEST_TYPE
The request type of Query requests. |
static java.lang.String |
STARTED_PARM_NAME
The name of the request parameter that is whether or not a Process must be started to be included in the result set |
static java.lang.String |
TYPE_PARM_NAME
The name of the request parameter that is the query type |
Fields inherited from class com.oakgrovesystems.reactor.requests.QueryRequest |
operandBuilder, policyBuilder, processBuilder, statusBuilder, useLabelPaths |
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest |
operandOutputter, policyOutputter, processOutputter, statusOutputter |
Constructor Summary | |
QueryProcesses()
Creates a QueryProcesses request without specifying the authentication token to use to make the request. |
|
QueryProcesses(java.lang.String authToken)
Creates a QueryProcesses request that will use the specified authentication token |
Method Summary | |
protected org.jdom.Element |
aceProfileElement(com.oakgrovesystems.reactor.processMediation.ACE ace)
|
com.oakgrovesystems.reactor.processMediation.ACE |
getACE()
returns the the ACE profile that must match an ACE in the ACL of a Process for it to be included in the result set |
boolean |
getMustBeDefinition()
returns the boolean indicating whether or not a Process must be a definition to be included in the result set |
boolean |
getMustBeInstance()
returns the boolean indicating whether or not a Process must be an instance to be included in the result set |
boolean |
getMustBeStarted()
returns the boolean indicating whether or not a Process must be started to be included in the result set |
boolean |
getReturnRefs()
returns the boolean indicating whether or not to return identifiers instead of the objects themselves in the result set |
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 |
void |
setACE(com.oakgrovesystems.reactor.processMediation.ACE profile)
Specifies the ACE profile that must match an ACE in the ACL of a Process for it to be included in the result set. |
void |
setMustBeDefinition(boolean mustBeDefinition)
Specifies whether or not a Process must be a definition to be included in the result set. |
void |
setMustBeInstance(boolean mustBeInstance)
Specifies whether or not a Process must be an instance to be included in the result set. |
void |
setMustBeStarted(boolean mustBeStarted)
Specifies whether or not a Process must be started to be included in the result set. |
void |
setReturnRefs(boolean returnRefs)
Specifies whether or not to return identifiers instead of the objects themselves in the result set. |
Methods inherited from class com.oakgrovesystems.reactor.requests.QueryRequest |
addObject, addOperand, addPolicy, addProcess, addReference, addStatus, createRtnValXML, getLabelPathFromReference, getUseLabelPaths, parseReturnValues, setUseLabelPaths |
Methods inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest |
configureFromXML, configureFromXML, createResponseXML, createResponseXML, createReturnValuesElem, 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 PROCESSES
public static final java.lang.String TYPE_PARM_NAME
public static final java.lang.String ACE_PROFILE_PARM_NAME
public static final java.lang.String DEFINITION_PARM_NAME
public static final java.lang.String INSTANCE_PARM_NAME
public static final java.lang.String STARTED_PARM_NAME
public static final java.lang.String REFERENCES_PARM_NAME
public static final java.lang.String REQUEST_TYPE
Constructor Detail |
public QueryProcesses()
public QueryProcesses(java.lang.String authToken)
authToken
- the authentication token to use to make the requestMethod Detail |
public void setACE(com.oakgrovesystems.reactor.processMediation.ACE profile)
profile
- the the ACE profile that must match an ACE in the ACL of a Process
for it to be included in the result setpublic com.oakgrovesystems.reactor.processMediation.ACE getACE()
public void setMustBeDefinition(boolean mustBeDefinition)
mustBeDefinition
- whether or not a Process must be a definition to be included in the result setpublic boolean getMustBeDefinition()
public void setMustBeInstance(boolean mustBeInstance)
mustBeInstance
- whether or not a Process must be an instance to be included in the result setpublic boolean getMustBeInstance()
public void setMustBeStarted(boolean mustBeStarted)
mustBeStarted
- whether or not a Process must be started to be included in the result setpublic boolean getMustBeStarted()
public void setReturnRefs(boolean returnRefs)
returnRefs
- whether or not to return identifiers instead of the objects themselves in the result setpublic boolean getReturnRefs()
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 org.jdom.Element aceProfileElement(com.oakgrovesystems.reactor.processMediation.ACE ace) throws FailedRequestException
FailedRequestException
public java.util.List paramsToXML() throws FailedRequestException
ReactorRequest
paramsToXML
in class ReactorRequest
FailedRequestException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |