com.oakgrovesystems.reactor.requests
Class QueryGeneral

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

public class QueryGeneral
extends ReactorRequest

A request for collection of Process Mediation Objects in the subtree matching a certain criteria. The possible criteria include:

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:

See Also:
Serialized Form

Field Summary
static java.lang.String ACE_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 DEPTH_PARM_NAME
          The name of the request parameter that is the depth of the tree to retrieve
static java.lang.String EXPAND_USER_PARM_NAME
          The name of the request parameter that indicates whether the user in an ACE should be expanded to include associated titles and groups.
static java.lang.String GENERAL_QUERY
          The type of a query for a process subtree
static java.lang.String GET_THIN_PROCESSES_PARM_NAME
          The name of the request parameter that indicates whether to deserialization conditions
static java.lang.String HAS_ASSOCIATED_OPERAND_ID_PARM_NAME
          The name of the request parameter that is the id of an operand that must be associated to the Process to be included in the result set
static java.lang.String HAS_ASSOCIATED_OPERAND_LABEL_PARM_NAME
          The name of the request parameter that is the label of an operand that must be associated to the Process to be included in the result set
static java.lang.String HAS_ASSOCIATED_POLICY_ID_PARM_NAME
          The name of the request parameter that is the id of a policy that must be associated to the Process to be included in the result set
static java.lang.String HAS_ASSOCIATED_POLICY_LABEL_PARM_NAME
          The name of the request parameter that is the label of a policy that must be associated to the Process to be included in the result set
static java.lang.String HAS_ASSOCIATED_STATUS_ID_PARM_NAME
          The name of the request parameter that is the id of a status that must be associated to the Process to be included in the result set
static java.lang.String HAS_ASSOCIATED_STATUS_LABEL_PARM_NAME
          The name of the request parameter that is the label of a status that must be associated to the Process to be included in the result set
static java.lang.String HAS_ASSOCIATED_SUBPROCESS_ID_PARM_NAME
          The name of the request parameter that is the id of a subprocess that must be associated to the Process to be included in the result set
static java.lang.String HAS_ASSOCIATED_SUBPROCESS_LABEL_PARM_NAME
          The name of the request parameter that is the label of a subprocess that must be associated to the Process to be included in the result set
static java.lang.String HAS_PARENT_ID_PARM_NAME
          The name of the request parameter that is the id of the parent process that a Process must have to be included in the result set
static java.lang.String HAS_PARENT_LABEL_PARM_NAME
          The name of the request parameter that is label id of the parent process that a Process must have to be included in the result set
static java.lang.String HAS_STATUS_ID_PARM_NAME
          The name of the request parameter that is the id of a status that a Process must have acquired to be included in the result set
static java.lang.String HAS_STATUS_LABEL_PARM_NAME
          The name of the request parameter that is the label of a status that a Process must have acquired to be included in the result set
static java.lang.String INCLUDE_OPERANDS_PARM_NAME
          The name of the request parameter that is whether or not to return Operands
static java.lang.String INCLUDE_PARENT_PARM_NAME
          The name of the request parameter that is whether or not to return the parent process
static java.lang.String INCLUDE_POLICIES_PARM_NAME
          The name of the request parameter that is whether or not to return Policies
static java.lang.String INCLUDE_STATUSES_PARM_NAME
          The name of the request parameter that is whether or not to return Statuses
static java.lang.String MUST_BE_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 MUST_BE_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 MUST_BE_ROOT_PARM_NAME
          The name of the request parameter that is whether or not a Process must be a root level process to be included in the result set
protected  com.oakgrovesystems.reactor.processMediation.xml.OperandBuilder operandBuilder
           
protected  com.oakgrovesystems.reactor.processMediation.xml.PolicyBuilder policyBuilder
           
static java.lang.String PROCESS_ID_PARM_NAME
          The name of the request parameter that is the id of the process
static java.lang.String PROCESS_LP_PARM_NAME
          The name of the request parameter that is the labelPath of the process
protected  com.oakgrovesystems.reactor.processMediation.xml.ProcessBuilder processBuilder
           
static java.lang.String REQUEST_TYPE
          The request type of Query requests.
static java.lang.String STATE_EQUALS_PARM_NAME
          The name of the request parameter that is the state that a Process must have to be included in the result set
protected  com.oakgrovesystems.reactor.processMediation.xml.StatusBuilder statusBuilder
           
static java.lang.String TYPE_PARM_NAME
          The name of the request parameter that is the query type
protected  boolean useLabelPaths
           
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
QueryGeneral()
          Creates a QueryGeneral request without specifying the authentication token to use to make the request.
QueryGeneral(java.lang.String authToken)
          Creates a QueryGeneral request that will use the specified authentication token
 
Method Summary
protected  org.jdom.Element aceProfileElement(com.oakgrovesystems.reactor.processMediation.ACE ace)
           
protected  void addObject(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  void addOperand(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  void addPolicy(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  void addProcess(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  void addReference(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  void addStatus(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  org.jdom.Element createRtnValXML(com.oakgrovesystems.reactor.ReactorResponse res, com.oakgrovesystems.reactor.IdToLabelPathMapper mapper)
          This (superclass) implementation simply returns null, which is perfect for requests that don't have return values.
 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
 java.lang.Integer getDepth()
          returns the depth of the tree to return
 boolean getExpandUser()
          Returns true if user should be expanded to include associated titles and groups.
 boolean getGetThinProcesses()
          Returns the boolean indicating to avoid deserialization.
 com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedOperandId()
          returns the id of the operand that must be assiciated with the process to be included in the result set
 java.lang.String getHasAssociatedOperandLabel()
          returns the label of the operand that must be assiciated with the process to be included in the result set
 com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedPolicyId()
          returns the id of the policy that must be associated with the process to be included in the result set
 java.lang.String getHasAssociatedPolicyLabel()
          returns the label of the policy that must be associated with the process to be included in the result set
 com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedStatusId()
          returns the id of the status that must be assiciated with the process to be included in the result set
 java.lang.String getHasAssociatedStatusLabel()
          returns the label of the status that must be associated with the process to be included in the result set
 com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedSubprocessId()
          returns the id of the subprocess that must be associated with the process to be included in the result set
 java.lang.String getHasAssociatedSubprocessLabel()
          returns the label of the subprocess that must be associated with the process to be included in the result set
 com.oakgrovesystems.reactor.ReactorObjectId getHasParentId()
          returns the id of the parent process that a process must have to be included in the result set
 java.lang.String getHasParentLabel()
          returns the label of the parent process that a process must have to be included in the result set
 com.oakgrovesystems.reactor.ReactorObjectId getHasStatusId()
          returns the id of the status that a process must have acquired to be included the result set
 java.lang.String getHasStatusLabel()
          returns the label of the status that a process must have acquired to be included in the result set
 boolean getIncludeOperands()
          returns the boolean indicating whether or not to include Operands in the result set
 boolean getIncludeParent()
          returns the boolean indicating whether or not to include in the result set the parent process of the Process tree
 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
protected  com.oakgrovesystems.reactor.LabelPath getLabelPathFromReference(org.jdom.Element refEl)
           
 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 getMustBeRoot()
          returns the boolean indicating whether or not a Process must be a root level process to be included in the result set
 com.oakgrovesystems.reactor.ReactorObjectId getProcessId()
          returns the id of the process
 com.oakgrovesystems.reactor.LabelPath getProcessLabelPath()
          returns the label path of the process
 java.lang.Integer getStateEquals()
          returns the state that a process must have to be included in the result set
 boolean getUseLabelPaths()
           
 java.util.List paramsToXML()
          Returns a List of Elements representing the parameters of the request
protected  void parseACEProfile(org.jdom.Element queryDetails)
           
protected  void parseDepth(org.jdom.Element queryDetails)
           
protected  void parseHasAssociatedOperand(org.jdom.Element queryDetails)
           
protected  void parseHasAssociatedPolicy(org.jdom.Element queryDetails)
           
protected  void parseHasAssociatedStatus(org.jdom.Element queryDetails)
           
protected  void parseHasAssociatedSubprocess(org.jdom.Element queryDetails)
           
protected  void parseHasParent(org.jdom.Element queryDetails)
           
protected  void parseHasStatus(org.jdom.Element queryDetails)
           
protected  void parseParameters(org.jdom.Element params, com.oakgrovesystems.reactor.LabelPathToIdMapper mapper)
          Configures the parameters from the XML representation
protected  void parseProcess(org.jdom.Element queryDetails)
           
protected  com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
           
protected  void parseStateEquals(org.jdom.Element queryDetails)
           
 void setACE(com.oakgrovesystems.reactor.processMediation.ACE ace)
          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 setDepth(int depth)
          Specifies the number of levels of subprocesses to return.
 void setExpandUser(boolean flag)
          Specifies a flag that is true if a user in the ACE should be expanded to include associated titles and groups.
 void setGetThinProcesses(boolean getThinProcesses)
          Specifies whether to avoid deserializing PCS-related params.
 void setHasAssociatedOperandId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedOperandId)
          Specifies the id of the operand that must be assiciated with the process to be included in the result set
 void setHasAssociatedOperandLabel(java.lang.String hasAssociatedOperandLabel)
          Specifies the label of the operand that must be assiciated with the process to be included in the result set
 void setHasAssociatedPolicyId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedPolicyId)
          Specifies the id of the policy that must be associated with the process to be included in the result set
 void setHasAssociatedPolicyLabel(java.lang.String hasAssociatedPolicyLabel)
          Specifies the label of the policy that must be associated with the process to be included in the result set
 void setHasAssociatedStatusId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedStatusId)
          Specifies the id of the status that must be assiciated with the process to be included in the result set
 void setHasAssociatedStatusLabel(java.lang.String hasAssociatedStatusLabel)
          Specifies the label of the status that must be assiciated with the process to be included in the result set
 void setHasAssociatedSubprocessId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedSubprocessId)
          Specifies the id of the subprocess that must be associated with the process to be included in the result set
 void setHasAssociatedSubprocessLabel(java.lang.String hasAssociatedSubprocessLabel)
          Specifies the label of the subprocess that must be associated with the process to be included in the result set
 void setHasParentId(com.oakgrovesystems.reactor.ReactorObjectId hasParentId)
          Specifies the id of the parent process that a process must have to be included in the result set
 void setHasParentLabel(java.lang.String hasParentLabel)
          Specifies the label of the parent process that a process must have to be included in the result set
 void setHasStatusId(com.oakgrovesystems.reactor.ReactorObjectId hasStatusId)
          Specifies the id of the status that a process must have acquited to be included in the result set
 void setHasStatusLabel(java.lang.String hasStatusLabel)
          Specifies the label of the status that a process must have acquired to be included in the result set
 void setIncludeOperands(boolean includeOperands)
          Specifies whether or not to include Operands in the result set.
 void setIncludeParent(boolean includeParent)
          Specifies whether or not to include in the result set the parent process of the Process tree.
 void setIncludePolicies(boolean includePolicies)
          Specifies whether or not to include Policies in the result set.
 void setIncludeStatuses(boolean includeStatuses)
          Specifies whether or not to include Statuses 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 setMustBeRoot(boolean mustBeRoot)
          Specifies whether or not a Process must be a root level process to be included in the result set.
 void setProcessId(com.oakgrovesystems.reactor.ReactorObjectId processId)
          Specifies the id of the process.
 void setProcessLabelPath(com.oakgrovesystems.reactor.LabelPath processLabelPath)
          Specifies the label path of the process.
 void setStateEquals(int stateEquals)
          Specifies the state that a Process must have to be included in the result set.
 void setUseLabelPaths(boolean value)
           
 
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

useLabelPaths

protected boolean useLabelPaths

processBuilder

protected com.oakgrovesystems.reactor.processMediation.xml.ProcessBuilder processBuilder

operandBuilder

protected com.oakgrovesystems.reactor.processMediation.xml.OperandBuilder operandBuilder

statusBuilder

protected com.oakgrovesystems.reactor.processMediation.xml.StatusBuilder statusBuilder

policyBuilder

protected com.oakgrovesystems.reactor.processMediation.xml.PolicyBuilder policyBuilder

TYPE_PARM_NAME

public static final java.lang.String TYPE_PARM_NAME
The name of the request parameter that is the query type

See Also:
Constant Field Values

GENERAL_QUERY

public static final java.lang.String GENERAL_QUERY
The type of a query for a process subtree

See Also:
Constant Field Values

PROCESS_ID_PARM_NAME

public static final java.lang.String PROCESS_ID_PARM_NAME
The name of the request parameter that is the id of the process

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 labelPath of the process

See Also:
Constant Field Values

ACE_PARM_NAME

public static final java.lang.String ACE_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

See Also:
Constant Field Values

EXPAND_USER_PARM_NAME

public static final java.lang.String EXPAND_USER_PARM_NAME
The name of the request parameter that indicates whether the user in an ACE should be expanded to include associated titles and groups.

See Also:
Constant Field Values

MUST_BE_DEFINITION_PARM_NAME

public static final java.lang.String MUST_BE_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

See Also:
Constant Field Values

MUST_BE_INSTANCE_PARM_NAME

public static final java.lang.String MUST_BE_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

See Also:
Constant Field Values

STATE_EQUALS_PARM_NAME

public static final java.lang.String STATE_EQUALS_PARM_NAME
The name of the request parameter that is the state that a Process must have to be included in the result set

See Also:
Constant Field Values

HAS_STATUS_ID_PARM_NAME

public static final java.lang.String HAS_STATUS_ID_PARM_NAME
The name of the request parameter that is the id of a status that a Process must have acquired to be included in the result set

See Also:
Constant Field Values

HAS_STATUS_LABEL_PARM_NAME

public static final java.lang.String HAS_STATUS_LABEL_PARM_NAME
The name of the request parameter that is the label of a status that a Process must have acquired to be included in the result set

See Also:
Constant Field Values

HAS_ASSOCIATED_OPERAND_ID_PARM_NAME

public static final java.lang.String HAS_ASSOCIATED_OPERAND_ID_PARM_NAME
The name of the request parameter that is the id of an operand that must be associated to the Process to be included in the result set

See Also:
Constant Field Values

HAS_ASSOCIATED_OPERAND_LABEL_PARM_NAME

public static final java.lang.String HAS_ASSOCIATED_OPERAND_LABEL_PARM_NAME
The name of the request parameter that is the label of an operand that must be associated to the Process to be included in the result set

See Also:
Constant Field Values

HAS_ASSOCIATED_STATUS_ID_PARM_NAME

public static final java.lang.String HAS_ASSOCIATED_STATUS_ID_PARM_NAME
The name of the request parameter that is the id of a status that must be associated to the Process to be included in the result set

See Also:
Constant Field Values

HAS_ASSOCIATED_STATUS_LABEL_PARM_NAME

public static final java.lang.String HAS_ASSOCIATED_STATUS_LABEL_PARM_NAME
The name of the request parameter that is the label of a status that must be associated to the Process to be included in the result set

See Also:
Constant Field Values

HAS_ASSOCIATED_POLICY_ID_PARM_NAME

public static final java.lang.String HAS_ASSOCIATED_POLICY_ID_PARM_NAME
The name of the request parameter that is the id of a policy that must be associated to the Process to be included in the result set

See Also:
Constant Field Values

HAS_ASSOCIATED_POLICY_LABEL_PARM_NAME

public static final java.lang.String HAS_ASSOCIATED_POLICY_LABEL_PARM_NAME
The name of the request parameter that is the label of a policy that must be associated to the Process to be included in the result set

See Also:
Constant Field Values

HAS_ASSOCIATED_SUBPROCESS_ID_PARM_NAME

public static final java.lang.String HAS_ASSOCIATED_SUBPROCESS_ID_PARM_NAME
The name of the request parameter that is the id of a subprocess that must be associated to the Process to be included in the result set

See Also:
Constant Field Values

HAS_ASSOCIATED_SUBPROCESS_LABEL_PARM_NAME

public static final java.lang.String HAS_ASSOCIATED_SUBPROCESS_LABEL_PARM_NAME
The name of the request parameter that is the label of a subprocess that must be associated to the Process to be included in the result set

See Also:
Constant Field Values

HAS_PARENT_ID_PARM_NAME

public static final java.lang.String HAS_PARENT_ID_PARM_NAME
The name of the request parameter that is the id of the parent process that a Process must have to be included in the result set

See Also:
Constant Field Values

HAS_PARENT_LABEL_PARM_NAME

public static final java.lang.String HAS_PARENT_LABEL_PARM_NAME
The name of the request parameter that is label id of the parent process that a Process must have to be included in the result set

See Also:
Constant Field Values

MUST_BE_ROOT_PARM_NAME

public static final java.lang.String MUST_BE_ROOT_PARM_NAME
The name of the request parameter that is whether or not a Process must be a root level process to be included in the result set

See Also:
Constant Field Values

DEPTH_PARM_NAME

public static final java.lang.String DEPTH_PARM_NAME
The name of the request parameter that is the depth of the tree to retrieve

See Also:
Constant Field Values

INCLUDE_OPERANDS_PARM_NAME

public static final java.lang.String INCLUDE_OPERANDS_PARM_NAME
The name of the request parameter that is whether or not to return Operands

See Also:
Constant Field Values

INCLUDE_STATUSES_PARM_NAME

public static final java.lang.String INCLUDE_STATUSES_PARM_NAME
The name of the request parameter that is whether or not to return Statuses

See Also:
Constant Field Values

INCLUDE_POLICIES_PARM_NAME

public static final java.lang.String INCLUDE_POLICIES_PARM_NAME
The name of the request parameter that is whether or not to return Policies

See Also:
Constant Field Values

INCLUDE_PARENT_PARM_NAME

public static final java.lang.String INCLUDE_PARENT_PARM_NAME
The name of the request parameter that is whether or not to return the parent process

See Also:
Constant Field Values

GET_THIN_PROCESSES_PARM_NAME

public static final java.lang.String GET_THIN_PROCESSES_PARM_NAME
The name of the request parameter that indicates whether to deserialization conditions

See Also:
Constant Field Values

REQUEST_TYPE

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

See Also:
Constant Field Values
Constructor Detail

QueryGeneral

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


QueryGeneral

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

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

setUseLabelPaths

public void setUseLabelPaths(boolean value)

getUseLabelPaths

public boolean getUseLabelPaths()

setProcessId

public void setProcessId(com.oakgrovesystems.reactor.ReactorObjectId processId)
Specifies the id of the process. Calling this method with a non-null parameter has the side effect of calling setProcessLabelPath with a null parameter.

Parameters:
processId - the id of the process to query

getProcessId

public com.oakgrovesystems.reactor.ReactorObjectId getProcessId()
returns the id of the process

Returns:
the id of the process

setProcessLabelPath

public void setProcessLabelPath(com.oakgrovesystems.reactor.LabelPath processLabelPath)
Specifies the label path of the process. Calling this method with a non-null parameter has the side effect of calling setProcessId with a null parameter.

Parameters:
processLabelPath - the label path the process to query

getProcessLabelPath

public com.oakgrovesystems.reactor.LabelPath getProcessLabelPath()
returns the label path of the process

Returns:
the label path of the process

setACE

public void setACE(com.oakgrovesystems.reactor.processMediation.ACE ace)
Specifies the ACE profile that must match an ACE in the ACL of a Process for it to be included in the result set. If none is specified, Processes are included regardless of their ACLs

Parameters:
ace - the the ACE profile that must match an ACE in the ACL of a Process for it to be included in the result set

getACE

public 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

Returns:
the ACE profile that must match an ACE in the ACL of a Process for it to be included in the result set

setExpandUser

public void setExpandUser(boolean flag)
Specifies a flag that is true if a user in the ACE should be expanded to include associated titles and groups.

Parameters:
flag - true if user should be expanded to include associated titles and groups for it to be included in the result set

getExpandUser

public boolean getExpandUser()
Returns true if user should be expanded to include associated titles and groups.

Returns:
true if user should be expanded to include associated titles and groups

setMustBeDefinition

public void setMustBeDefinition(boolean mustBeDefinition)
Specifies whether or not a Process must be a definition to be included in the result set. Defaults to false if uncalled.

Parameters:
mustBeDefinition - whether or not a Process must be a definition to be included in the result set

getMustBeDefinition

public boolean getMustBeDefinition()
returns the boolean indicating whether or not a Process must be a definition to be included in the result set

Returns:
the boolean indicating whether or not a Process must be a definition to be included in the result set

setMustBeInstance

public void setMustBeInstance(boolean mustBeInstance)
Specifies whether or not a Process must be an instance to be included in the result set. Defaults to false if uncalled.

Parameters:
mustBeInstance - whether or not a Process must be an instance to be included in the result set

getMustBeInstance

public boolean getMustBeInstance()
returns the boolean indicating whether or not a Process must be an instance to be included in the result set

Returns:
the boolean indicating whether or not a Process must be an instance to be included in the result set

setStateEquals

public void setStateEquals(int stateEquals)
Specifies the state that a Process must have to be included in the result set. Set as one of the following values

Parameters:
stateEquals - the state of a process

getStateEquals

public java.lang.Integer getStateEquals()
returns the state that a process must have to be included in the result set

Returns:
the state that a process must have to be included in the result set

setHasStatusId

public void setHasStatusId(com.oakgrovesystems.reactor.ReactorObjectId hasStatusId)
Specifies the id of the status that a process must have acquited to be included in the result set

Parameters:
hasStatusId - the id of the status that a process must have acquired

getHasStatusId

public com.oakgrovesystems.reactor.ReactorObjectId getHasStatusId()
returns the id of the status that a process must have acquired to be included the result set

Returns:
the id of the status that a process must have acquired.

setHasStatusLabel

public void setHasStatusLabel(java.lang.String hasStatusLabel)
Specifies the label of the status that a process must have acquired to be included in the result set

Parameters:
hasStatusLabel - the label of the status that a process must have acquired

getHasStatusLabel

public java.lang.String getHasStatusLabel()
returns the label of the status that a process must have acquired to be included in the result set

Returns:
the label of the status that a process must have acquired

setHasAssociatedOperandId

public void setHasAssociatedOperandId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedOperandId)
Specifies the id of the operand that must be assiciated with the process to be included in the result set

Parameters:
hasAssociatedOperandId - the id of the operand that must be associated with the process

getHasAssociatedOperandId

public com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedOperandId()
returns the id of the operand that must be assiciated with the process to be included in the result set

Returns:
the id of the operand that must be associated with the process

setHasAssociatedOperandLabel

public void setHasAssociatedOperandLabel(java.lang.String hasAssociatedOperandLabel)
Specifies the label of the operand that must be assiciated with the process to be included in the result set

Parameters:
hasAssociatedOperandLabel - the id of the operand that must be associated with the process

getHasAssociatedOperandLabel

public java.lang.String getHasAssociatedOperandLabel()
returns the label of the operand that must be assiciated with the process to be included in the result set

Returns:
the label of the operand that must be associated with the process

setHasAssociatedStatusId

public void setHasAssociatedStatusId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedStatusId)
Specifies the id of the status that must be assiciated with the process to be included in the result set

Parameters:
hasAssociatedStatusId - the id of the status that must be associated with the process

getHasAssociatedStatusId

public com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedStatusId()
returns the id of the status that must be assiciated with the process to be included in the result set

Returns:
the id of the status that must be associated with the process

setHasAssociatedStatusLabel

public void setHasAssociatedStatusLabel(java.lang.String hasAssociatedStatusLabel)
Specifies the label of the status that must be assiciated with the process to be included in the result set

Parameters:
hasAssociatedStatusLabel - the id of the status that must be associated with the process

getHasAssociatedStatusLabel

public java.lang.String getHasAssociatedStatusLabel()
returns the label of the status that must be associated with the process to be included in the result set

Returns:
the label of the status that must be associated with the process

setHasAssociatedPolicyId

public void setHasAssociatedPolicyId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedPolicyId)
Specifies the id of the policy that must be associated with the process to be included in the result set

Parameters:
hasAssociatedPolicyId - the id of the policy that must be associated with the process

getHasAssociatedPolicyId

public com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedPolicyId()
returns the id of the policy that must be associated with the process to be included in the result set

Returns:
the id of the policy that must be associated with the process

setHasAssociatedPolicyLabel

public void setHasAssociatedPolicyLabel(java.lang.String hasAssociatedPolicyLabel)
Specifies the label of the policy that must be associated with the process to be included in the result set

Parameters:
hasAssociatedPolicyLabel - the label of the policy that must be associated with the process

getHasAssociatedPolicyLabel

public java.lang.String getHasAssociatedPolicyLabel()
returns the label of the policy that must be associated with the process to be included in the result set

Returns:
the label of the policy that must be associated with the process

setHasAssociatedSubprocessId

public void setHasAssociatedSubprocessId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedSubprocessId)
Specifies the id of the subprocess that must be associated with the process to be included in the result set

Parameters:
hasAssociatedSubprocessId - the id of the subprocess that must be associated with the process

getHasAssociatedSubprocessId

public com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedSubprocessId()
returns the id of the subprocess that must be associated with the process to be included in the result set

Returns:
the id of the subprocess that must be associated with the process

setHasAssociatedSubprocessLabel

public void setHasAssociatedSubprocessLabel(java.lang.String hasAssociatedSubprocessLabel)
Specifies the label of the subprocess that must be associated with the process to be included in the result set

Parameters:
hasAssociatedSubprocessLabel - the label of the subprocess that must be associated with the process

getHasAssociatedSubprocessLabel

public java.lang.String getHasAssociatedSubprocessLabel()
returns the label of the subprocess that must be associated with the process to be included in the result set

Returns:
the label of the subprocess that must be associated with the process

setHasParentId

public void setHasParentId(com.oakgrovesystems.reactor.ReactorObjectId hasParentId)
Specifies the id of the parent process that a process must have to be included in the result set

Parameters:
hasParentId - the id of the parent process that a process must have

getHasParentId

public com.oakgrovesystems.reactor.ReactorObjectId getHasParentId()
returns the id of the parent process that a process must have to be included in the result set

Returns:
the id of the parent process that a process must have

setHasParentLabel

public void setHasParentLabel(java.lang.String hasParentLabel)
Specifies the label of the parent process that a process must have to be included in the result set

Parameters:
hasParentLabel - the label of the parent process that a process must have

getHasParentLabel

public java.lang.String getHasParentLabel()
returns the label of the parent process that a process must have to be included in the result set

Returns:
the label of the parent process that a process must have

setMustBeRoot

public void setMustBeRoot(boolean mustBeRoot)
Specifies whether or not a Process must be a root level process to be included in the result set. Defaults to false if uncalled.

Parameters:
mustBeRoot - whether or not a Process must be a root level process to be included in the result set

getMustBeRoot

public boolean getMustBeRoot()
returns the boolean indicating whether or not a Process must be a root level process to be included in the result set

Returns:
the boolean indicating whether or not a Process must be a root level process to be included in the result set

setDepth

public void setDepth(int depth)
Specifies the number of levels of subprocesses to return. Defaults to 0 if uncalled. Negative means the entire depth of the tree

Parameters:
depth - the number of levels of subprocesses to return

getDepth

public java.lang.Integer getDepth()
returns the depth of the tree to return

Returns:
the depth of the tree to return

setIncludeOperands

public void setIncludeOperands(boolean includeOperands)
Specifies whether or not to include Operands in the result set. Defaults to false if uncalled.


getIncludeOperands

public boolean getIncludeOperands()
returns the boolean indicating whether or not to include Operands in the result set

Returns:
the boolean indicating whether or not to include Operands in the result set

setIncludeStatuses

public void setIncludeStatuses(boolean includeStatuses)
Specifies whether or not to include Statuses in the result set. Defaults to false if uncalled.


getIncludeStatuses

public boolean getIncludeStatuses()
returns the boolean indicating whether or not to include Statuses in the result set

Returns:
the boolean indicating whether or not to include Statuses in the result set

setIncludePolicies

public void setIncludePolicies(boolean includePolicies)
Specifies whether or not to include Policies in the result set. Defaults to false if uncalled.


getIncludePolicies

public boolean getIncludePolicies()
returns the boolean indicating whether or not to include Policies in the result set

Returns:
the boolean indicating whether or not to include Policies in the result set

setIncludeParent

public void setIncludeParent(boolean includeParent)
Specifies whether or not to include in the result set the parent process of the Process tree. Defaults to false if uncalled.

Parameters:
includeParent - whether or not to include in the result set parent process of the Process tree

getIncludeParent

public boolean getIncludeParent()
returns the boolean indicating whether or not to include in the result set the parent process of the Process tree

Returns:
the boolean indicating whether or not to include in the result set the parent process of the Process tree

setGetThinProcesses

public void setGetThinProcesses(boolean getThinProcesses)
Specifies whether to avoid deserializing PCS-related params. Defaults to false.


getGetThinProcesses

public boolean getGetThinProcesses()
Returns the boolean indicating to avoid deserialization.

Returns:
the boolean indicating whether to not deseralize

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

public 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

parseProcess

protected void parseProcess(org.jdom.Element queryDetails)
                     throws FailedRequestException
FailedRequestException

parseACEProfile

protected void parseACEProfile(org.jdom.Element queryDetails)
                        throws ProcessMediationException
ProcessMediationException

parseStateEquals

protected void parseStateEquals(org.jdom.Element queryDetails)
                         throws FailedRequestException
FailedRequestException

parseHasStatus

protected void parseHasStatus(org.jdom.Element queryDetails)
                       throws FailedRequestException
FailedRequestException

parseHasAssociatedOperand

protected void parseHasAssociatedOperand(org.jdom.Element queryDetails)
                                  throws FailedRequestException
FailedRequestException

parseHasAssociatedStatus

protected void parseHasAssociatedStatus(org.jdom.Element queryDetails)
                                 throws FailedRequestException
FailedRequestException

parseHasAssociatedPolicy

protected void parseHasAssociatedPolicy(org.jdom.Element queryDetails)
                                 throws FailedRequestException
FailedRequestException

parseHasAssociatedSubprocess

protected void parseHasAssociatedSubprocess(org.jdom.Element queryDetails)
                                     throws FailedRequestException
FailedRequestException

parseHasParent

protected void parseHasParent(org.jdom.Element queryDetails)
                       throws FailedRequestException
FailedRequestException

parseDepth

protected void parseDepth(org.jdom.Element queryDetails)
                   throws FailedRequestException
FailedRequestException

aceProfileElement

protected org.jdom.Element aceProfileElement(com.oakgrovesystems.reactor.processMediation.ACE ace)
                                      throws FailedRequestException
FailedRequestException

parseReturnValues

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

addObject

protected void addObject(com.oakgrovesystems.reactor.requests.QueryResponse response,
                         org.jdom.Element e)
                  throws FailedRequestException
FailedRequestException

addProcess

protected void addProcess(com.oakgrovesystems.reactor.requests.QueryResponse response,
                          org.jdom.Element e)
                   throws com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException

addOperand

protected void addOperand(com.oakgrovesystems.reactor.requests.QueryResponse response,
                          org.jdom.Element e)
                   throws com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException

addStatus

protected void addStatus(com.oakgrovesystems.reactor.requests.QueryResponse response,
                         org.jdom.Element e)
                  throws com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException

addPolicy

protected void addPolicy(com.oakgrovesystems.reactor.requests.QueryResponse response,
                         org.jdom.Element e)
                  throws com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException

addReference

protected void addReference(com.oakgrovesystems.reactor.requests.QueryResponse response,
                            org.jdom.Element e)
                     throws com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException

getLabelPathFromReference

protected com.oakgrovesystems.reactor.LabelPath getLabelPathFromReference(org.jdom.Element refEl)
                                                                   throws com.oakgrovesystems.reactor.processMediation.xml.ReactorObjectIdConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ReactorObjectIdConstructionException

createRtnValXML

protected org.jdom.Element createRtnValXML(com.oakgrovesystems.reactor.ReactorResponse res,
                                           com.oakgrovesystems.reactor.IdToLabelPathMapper mapper)
                                    throws FailedRequestException
Description copied from class: ReactorRequest
This (superclass) implementation simply returns null, which is perfect for requests that don't have return values. Subclass implementations should override this method if they have return values. This method should return a 'return_values' Element or null if there are no return values. A precondition of this method is that the ReactorResponse parameter is not a failure.

Overrides:
createRtnValXML in class ReactorRequest
Parameters:
res - the ReactorResponse to translate to XML.
mapper - object to convert IDs to label paths in return values
Returns:
the XML representation of the return values
Throws:
FailedRequestException - if the return values Element can't be created


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