|
|||||||||||
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.QueryProcessTree
A request for the Set of Process Mediation Objects in the subtree with the specified root Process. The depth parameter specifies the number of levels of subprocesses to include in the tree (negative implies the entire depth of the subtree). The query always returns all the Process objects in the tree to the specified depth. In addition, it can optionally include any or all of:
Field Summary | |
static java.lang.String |
DEF_ONLY_PARM_NAME
The name of the request parameter that is the boolean indicating that only Definition trees should be returned. |
static java.lang.String |
DEPTH_PARM_NAME
The name of the request parameter that is the depth of the tree to retrieve |
static java.lang.String |
GET_OPERANDS_PARM_NAME
The name of the request parameter that is whether or not to return Operands |
static java.lang.String |
GET_POLICIES_PARM_NAME
The name of the request parameter that is whether or not to return Policies |
static java.lang.String |
GET_STATUSES_PARM_NAME
The name of the request parameter that is whether or not to return Statuses |
static java.lang.String |
GET_SUPERPROCESS_PARM_NAME
The name of the request parameter that is whether or not to return the superprocess |
static java.lang.String |
ID_PARM_NAME
The name of the request parameter that is the id of the root of the tree |
static java.lang.String |
LABEL_PATH_PARM_NAME
The name of the request parameter that is the label path of the root of the tree |
static java.lang.String |
PROCESS_TREE
The type of a query for a process subtree |
static java.lang.String |
REQUEST_TYPE
The request type of Query requests. |
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 | |
QueryProcessTree()
Creates a QueryProcessTree request without specifying the authentication token to use to make the request. |
|
QueryProcessTree(java.lang.String authToken)
Creates a QueryProcessTree request that will use the specified authentication token |
Method Summary | |
boolean |
getDefinitionTreeOnly()
returns the request parameter that is the boolean indicating that only Definition trees should be returned. |
java.lang.Integer |
getDepth()
returns the depth of the tree to return |
com.oakgrovesystems.reactor.ReactorObjectId |
getId()
returns the id of the root of the tree |
boolean |
getIncludeOperands()
returns the boolean indicating whether or not to include Operands in the result set |
boolean |
getIncludePolicies()
returns the boolean indicating whether or not to include Policies in the result set |
boolean |
getIncludeStatuses()
returns the boolean indicating whether or not to include Statuses in the result set |
boolean |
getIncludeSuperprocess()
returns the boolean indicating whether or not to include in the result set the superprocess of the root of the Process tree |
com.oakgrovesystems.reactor.LabelPath |
getLabelPath()
returns the label path of the root of the tree |
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 |
setDefinitionTreeOnly(boolean gdto)
sets the request parameter that is the boolean indicating that only Definition trees should be returned. |
void |
setDepth(int depth)
|
void |
setDepth(java.lang.Integer depth)
Specifies the number of levels of subprocesses to return. |
void |
setId(com.oakgrovesystems.reactor.ReactorObjectId id)
Specifies the id of the root of the tree. |
void |
setIncludeOperands(boolean getOperands)
Specifies whether or not to include Operands in the result set. |
void |
setIncludePolicies(boolean getPolicies)
Specifies whether or not to include Policies in the result set. |
void |
setIncludeStatuses(boolean getStatuses)
Specifies whether or not to include Statuses in the result set. |
void |
setIncludeSuperprocess(boolean getSuperprocess)
Specifies whether or not to include in the result set the superprocess of the root of the Process tree. |
void |
setLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
Specifies the label path of the root of the tree. |
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 PROCESS_TREE
public static final java.lang.String TYPE_PARM_NAME
public static final java.lang.String ID_PARM_NAME
public static final java.lang.String LABEL_PATH_PARM_NAME
public static final java.lang.String DEF_ONLY_PARM_NAME
public static final java.lang.String DEPTH_PARM_NAME
public static final java.lang.String GET_SUPERPROCESS_PARM_NAME
public static final java.lang.String GET_OPERANDS_PARM_NAME
public static final java.lang.String GET_STATUSES_PARM_NAME
public static final java.lang.String GET_POLICIES_PARM_NAME
public static final java.lang.String REQUEST_TYPE
Constructor Detail |
public QueryProcessTree()
public QueryProcessTree(java.lang.String authToken)
authToken
- the authentication token to use to make the requestMethod Detail |
public void setId(com.oakgrovesystems.reactor.ReactorObjectId id)
id
- the id of the root of the treepublic com.oakgrovesystems.reactor.ReactorObjectId getId()
public void setLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
lp
- the label path of the root of the treepublic com.oakgrovesystems.reactor.LabelPath getLabelPath()
public void setDefinitionTreeOnly(boolean gdto)
gdto
- the value of the boolean request parameterpublic boolean getDefinitionTreeOnly()
public void setDepth(java.lang.Integer depth)
depth
- the number of levels of subprocesses to returnpublic void setDepth(int depth)
public java.lang.Integer getDepth()
public void setIncludeSuperprocess(boolean getSuperprocess)
getSuperprocess
- whether or not to include in the result set the superprocess of
the root of the Process treepublic boolean getIncludeSuperprocess()
public void setIncludeOperands(boolean getOperands)
getOperands
- whether or not to include Operands in the result setpublic boolean getIncludeOperands()
public void setIncludeStatuses(boolean getStatuses)
getStatuses
- whether or not to include Statuses in the result setpublic boolean getIncludeStatuses()
public void setIncludePolicies(boolean getPolicies)
getPolicies
- whether or not to include Policies in the result setpublic boolean getIncludePolicies()
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.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 |