com.oakgrovesystems.reactor.client
Class QueryCriteria

java.lang.Object
  |
  +--com.oakgrovesystems.reactor.client.QueryCriteria

public class QueryCriteria
extends java.lang.Object

This class is used to set the criteria for the query. Various combination of criteria can be set.


Field Summary
protected  com.oakgrovesystems.reactor.processMediation.ACE ace
           
protected  int depth
           
protected  boolean expandUser
           
protected  boolean getThinProcesses
           
protected  com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedOperandId
           
protected  java.lang.String hasAssociatedOperandLabel
           
protected  java.lang.String hasAssociatedOperandValue
           
protected  com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedPolicyId
           
protected  java.lang.String hasAssociatedPolicyLabel
           
protected  com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedStatusId
           
protected  java.lang.String hasAssociatedStatusLabel
           
protected  com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedSubprocessId
           
protected  java.lang.String hasAssociatedSubprocessLabel
           
protected  com.oakgrovesystems.reactor.ReactorObjectId hasParentId
           
protected  java.lang.String hasParentLabel
           
protected  com.oakgrovesystems.reactor.ReactorObjectId hasStatusId
           
protected  java.lang.String hasStatusLabel
           
protected  boolean includeOperands
           
protected  boolean includeParent
           
protected  boolean includePolicies
           
protected  boolean includeStatuses
           
protected  boolean mustBeDefinition
           
protected  boolean mustBeInstance
           
protected  boolean mustBeRoot
           
protected  com.oakgrovesystems.reactor.ReactorObjectId processId
           
protected  com.oakgrovesystems.reactor.LabelPath processLabelPath
           
protected  int stateEquals
           
 
Constructor Summary
QueryCriteria()
          Creates a new criteria with the following defaults: mustBeDefinition = false mustBeInstance = false stateEquals = 0 (Don't care) mustBeRoot = false depth = 0 includeOperands = false includeStatuses = false includePolicies = false includeParent = false includeParent = false expandUser = true
 
Method Summary
 com.oakgrovesystems.reactor.processMediation.ACE getACE()
          Gets the ace attribute of the criteria
 int getDepth()
          Gets the depth attribute of the criteria
 boolean getExpandUser()
          Gets the expandUser attribute of the criteria.
 boolean getGetThinProcesses()
          Gets getThing attribute of the criteria
 com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedOperandId()
          Gets hasAssociatedOperandId attribute of the criteria
 java.lang.String getHasAssociatedOperandLabel()
          Gets hasAssociatedOperandLabel attribute of the criteria
 com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedPolicyId()
          Gets hasAssociatedPolicyId attribute of the criteria
 java.lang.String getHasAssociatedPolicyLabel()
          Gets hasAssociatedPolicyLabel attribute of the criteria
 com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedStatusId()
          Gets hasAssociatedStatusId attribute of the criteria
 java.lang.String getHasAssociatedStatusLabel()
          Gets hasAssociatedStatusLabel attribute of the criteria
 com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedSubprocessId()
          Gets hasAssociatedSubprocessId attribute of the criteria
 java.lang.String getHasAssociatedSubprocessLabel()
          Gets hasAssociatedSubprocessLabel attribute of the criteria
 com.oakgrovesystems.reactor.ReactorObjectId getHasParentId()
          Gets hasParentId attribute of the criteria
 java.lang.String getHasParentLabel()
          Gets hasParentLabel attribute of the criteria
 com.oakgrovesystems.reactor.ReactorObjectId getHasStatusId()
          Gets the hasStatusId attribute of the criteria.
 java.lang.String getHasStatusLabel()
          Gets the hasStatusLabel attribute of the criteria.
 boolean getIncludeOperands()
          Gets includeOperands attribute of the criteria
 boolean getIncludeParent()
          Gets includeParent attribute of the criteria
 boolean getIncludePolicies()
          Gets includePolicies attribute of the criteria
 boolean getIncludeStatuses()
          Gets includeStatuses attribute of the criteria
 boolean getMustBeDefinition()
          Gets must be definition attribute of criteria
 boolean getMustBeInstance()
          Gets must be instance attribute of criteria
 boolean getMustBeRoot()
          Gets mustBeRoot attribute of the criteria
 com.oakgrovesystems.reactor.ReactorObjectId getProcessId()
          Gets the process id of the criteria.
 com.oakgrovesystems.reactor.LabelPath getProcessLabelPath()
          Gets the process label path of the criteria.
 int getStateEquals()
          Gets the state equals attribute of the criteria
 void setACE(com.oakgrovesystems.reactor.processMediation.ACE ace)
          Sets the ace attribute of the criteria Use this criteria to query for process that has a similar ace.
 void setDepth(int depth)
          Sets depth attribute of the criteria Use this attribute to set the depth of process tree to get.
 void setExpandUser(boolean flag)
          Sets the expandUser attribute of the criteria.
 void setGetThinProcesses(boolean getThinProcesses)
          Sets getThin attribute of the criteria Use this attribute to disable deserialization of PCS-related data.
 void setHasAssociatedOperandId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedOperandId)
          Sets hasAssociatedOperandId attribute of the criteria Use this attribute to query for processes that has an associated operand with this id
 void setHasAssociatedOperandLabel(java.lang.String hasAssociatedOperandLabel)
          Sets hasAssociatedOperandLabel attribute of the criteria Use this attribute to query for processes that has an associated operand with this label
 void setHasAssociatedPolicyId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedPolicyId)
          Sets hasAssociatedPolicyId attribute of the criteria Use this attribute to query for processes that has an associated policy with this id
 void setHasAssociatedPolicyLabel(java.lang.String hasAssociatedPolicyLabel)
          Sets hasAssociatedPolicyLabel attribute of the criteria Use this attribute to query for processes that has an associated policy with this label
 void setHasAssociatedStatusId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedStatusId)
          Sets hasAssociatedStatusId attribute of the criteria Use this attribute to query for processes that has an associated status with this id
 void setHasAssociatedStatusLabel(java.lang.String hasAssociatedStatusLabel)
          Sets hasAssociatedStatusLabel attribute of the criteria Use this attribute to query for processes that has an associated status with this label
 void setHasAssociatedSubprocessId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedSubprocessId)
          Sets hasAssociatedSubprocessId attribute of the criteria Use this attribute to query for processes that has an associated subprocess with this id
 void setHasAssociatedSubprocessLabel(java.lang.String hasAssociatedSubprocessLabel)
          Sets hasAssociatedSubprocessLabel attribute of the criteria Use this attribute to query for processes that has an associated subprocess with this label
 void setHasParentId(com.oakgrovesystems.reactor.ReactorObjectId hasParentId)
          Sets hasParentId attribute of the criteria Use this attribute to query for processes that has a parent process with this id
 void setHasParentLabel(java.lang.String hasParentLabel)
          Sets hasParentLabel attribute of the criteria Use this attribute to query for processes that has a parent process with this label
 void setHasStatusId(com.oakgrovesystems.reactor.ReactorObjectId hasStatusId)
          Sets the hasStatusId attribute of the criteria Use this attribute to query for processes that has acquired this status
 void setHasStatusLabel(java.lang.String hasStatusLabel)
          Sets the hasStatusLabel attribute of the criteria Use this attribute to query for processes that has acquired a status with this label
 void setIncludeOperands(boolean includeOperands)
          Sets includeOperands attribute of the criteria Use this attribute to retrieve operands associated with a process
 void setIncludeParent(boolean includeParent)
          Sets includeParent attribute of the criteria Use this attribute to retrieve parent of a process
 void setIncludePolicies(boolean includePolicies)
          Sets includePolicies attribute of the criteria Use this attribute to retrieve policies associated with a process
 void setIncludeStatuses(boolean includeStatuses)
          Sets includeStatuses attribute of the criteria Use this attribute to retrieve statuses associated with a process
 void setMustBeDefinition(boolean mustBeDefinition)
          Sets must Be definition attribute of criteria Use this attribute to query for processes that are definitions This attriubte is set to false by default
 void setMustBeInstance(boolean mustBeInstance)
          Sets must Be instnace attribute of criteria Use this attribute to query for processes that are instances.
 void setMustBeRoot(boolean mustBeRoot)
          Sets mustBeRoot attribute of the criteria Use this criteria to query for rool level processes
 void setProcessId(com.oakgrovesystems.reactor.ReactorObjectId processId)
          Sets process id of the criteria Use this criteria to query a process with a particular id.
 void setProcessLabelPath(com.oakgrovesystems.reactor.LabelPath processLabelPath)
          Sets process label path of the criteria Use this criteria to query a process with a particular label path.
 void setStateEquals(int stateEquals)
          Sets stateEquals attribute of the criteria Use this attribute to query by process's state.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

processId

protected com.oakgrovesystems.reactor.ReactorObjectId processId

processLabelPath

protected com.oakgrovesystems.reactor.LabelPath processLabelPath

ace

protected com.oakgrovesystems.reactor.processMediation.ACE ace

expandUser

protected boolean expandUser

mustBeDefinition

protected boolean mustBeDefinition

mustBeInstance

protected boolean mustBeInstance

stateEquals

protected int stateEquals

hasStatusId

protected com.oakgrovesystems.reactor.ReactorObjectId hasStatusId

hasStatusLabel

protected java.lang.String hasStatusLabel

hasAssociatedOperandId

protected com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedOperandId

hasAssociatedOperandLabel

protected java.lang.String hasAssociatedOperandLabel

hasAssociatedOperandValue

protected java.lang.String hasAssociatedOperandValue

hasAssociatedStatusId

protected com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedStatusId

hasAssociatedStatusLabel

protected java.lang.String hasAssociatedStatusLabel

hasAssociatedPolicyId

protected com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedPolicyId

hasAssociatedPolicyLabel

protected java.lang.String hasAssociatedPolicyLabel

hasAssociatedSubprocessId

protected com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedSubprocessId

hasAssociatedSubprocessLabel

protected java.lang.String hasAssociatedSubprocessLabel

hasParentId

protected com.oakgrovesystems.reactor.ReactorObjectId hasParentId

hasParentLabel

protected java.lang.String hasParentLabel

mustBeRoot

protected boolean mustBeRoot

depth

protected int depth

includeOperands

protected boolean includeOperands

includeStatuses

protected boolean includeStatuses

includePolicies

protected boolean includePolicies

includeParent

protected boolean includeParent

getThinProcesses

protected boolean getThinProcesses
Constructor Detail

QueryCriteria

public QueryCriteria()
Creates a new criteria with the following defaults:

Method Detail

setProcessId

public void setProcessId(com.oakgrovesystems.reactor.ReactorObjectId processId)
Sets process id of the criteria Use this criteria to query a process with a particular id. Set it to null to ignore this attribute of the criteria

Parameters:
processId - The id of the process to query

getProcessId

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

Returns:
the id of the process to query if selected else returns null

setProcessLabelPath

public void setProcessLabelPath(com.oakgrovesystems.reactor.LabelPath processLabelPath)
Sets process label path of the criteria Use this criteria to query a process with a particular label path. Set it to null to ignore this attribute of the criteria

Parameters:
processLabelPath - The label path of the process to query

getProcessLabelPath

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

Returns:
the label path of the process to query if selected else returns null

setACE

public void setACE(com.oakgrovesystems.reactor.processMediation.ACE ace)
Sets the ace attribute of the criteria Use this criteria to query for process that has a similar ace.

Parameters:
ace - the ace to query for

getACE

public com.oakgrovesystems.reactor.processMediation.ACE getACE()
Gets the ace attribute of the criteria

Returns:
the ace if selected else returns null

setExpandUser

public void setExpandUser(boolean flag)
Sets the expandUser attribute of the criteria. Use this with setACE() to include titles and groups associated with the user in an ACE. This is set to "true" by default.

Parameters:
flag - true if user should be expanded, false otherwise

getExpandUser

public boolean getExpandUser()
Gets the expandUser attribute of the criteria. Use this with getACE() to see if titles and groups associated with the user in an ACE will included in the query. This is set to "true" by default.

Returns:
true if user should be expanded, false otherwise

setMustBeDefinition

public void setMustBeDefinition(boolean mustBeDefinition)
Sets must Be definition attribute of criteria Use this attribute to query for processes that are definitions This attriubte is set to false by default

Parameters:
mustBeDefinition - must be set to true to query for processes that are definitions

getMustBeDefinition

public boolean getMustBeDefinition()
Gets must be definition attribute of criteria

Returns:
true if selected else returns false

setMustBeInstance

public void setMustBeInstance(boolean mustBeInstance)
Sets must Be instnace attribute of criteria Use this attribute to query for processes that are instances. This is attribute is set to false be default

Parameters:
mustBeInstance - must be set to true to query for processes that are instances

getMustBeInstance

public boolean getMustBeInstance()
Gets must be instance attribute of criteria

Returns:
true if selected else returns false

setStateEquals

public void setStateEquals(int stateEquals)
Sets stateEquals attribute of the criteria Use this attribute to query by process's state. Set as one of the following values

Parameters:
stateEquals - the state of the process

getStateEquals

public int getStateEquals()
Gets the state equals attribute of the criteria

Returns:
the state of the process

setHasStatusId

public void setHasStatusId(com.oakgrovesystems.reactor.ReactorObjectId hasStatusId)
Sets the hasStatusId attribute of the criteria Use this attribute to query for processes that has acquired this status

Parameters:
hasStatusId - the id of the status that process has acquired

getHasStatusId

public com.oakgrovesystems.reactor.ReactorObjectId getHasStatusId()
Gets the hasStatusId attribute of the criteria.

Returns:
the hasStatusId attribute of the criteria

setHasStatusLabel

public void setHasStatusLabel(java.lang.String hasStatusLabel)
Sets the hasStatusLabel attribute of the criteria Use this attribute to query for processes that has acquired a status with this label

Parameters:
hasStatusLabel - the label of the status that process has acquired

getHasStatusLabel

public java.lang.String getHasStatusLabel()
Gets the hasStatusLabel attribute of the criteria.

Returns:
the hasStatusLabel attribute of the criteria

setHasAssociatedOperandId

public void setHasAssociatedOperandId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedOperandId)
Sets hasAssociatedOperandId attribute of the criteria Use this attribute to query for processes that has an associated operand with this id

Parameters:
hasAssociatedOperandId - the id of the operand associated with the process

getHasAssociatedOperandId

public com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedOperandId()
Gets hasAssociatedOperandId attribute of the criteria

Returns:
the hasAssociatedOperandId attribute of the criteria

setHasAssociatedOperandLabel

public void setHasAssociatedOperandLabel(java.lang.String hasAssociatedOperandLabel)
Sets hasAssociatedOperandLabel attribute of the criteria Use this attribute to query for processes that has an associated operand with this label

Parameters:
hasAssociatedOperandLabel - the label of the operand associated with the process

getHasAssociatedOperandLabel

public java.lang.String getHasAssociatedOperandLabel()
Gets hasAssociatedOperandLabel attribute of the criteria

Returns:
the hasAssociatedOperandLabel attribute of the criteria

setHasAssociatedStatusId

public void setHasAssociatedStatusId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedStatusId)
Sets hasAssociatedStatusId attribute of the criteria Use this attribute to query for processes that has an associated status with this id

Parameters:
hasAssociatedStatusId - the id of the status associated with the process

getHasAssociatedStatusId

public com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedStatusId()
Gets hasAssociatedStatusId attribute of the criteria

Returns:
the hasAssociatedStatusId attribute of the criteria

setHasAssociatedStatusLabel

public void setHasAssociatedStatusLabel(java.lang.String hasAssociatedStatusLabel)
Sets hasAssociatedStatusLabel attribute of the criteria Use this attribute to query for processes that has an associated status with this label

Parameters:
hasAssociatedStatusLabel - the label of the status associated with the process

getHasAssociatedStatusLabel

public java.lang.String getHasAssociatedStatusLabel()
Gets hasAssociatedStatusLabel attribute of the criteria

Returns:
the hasAssociatedStatusLabel attribute of the criteria

setHasAssociatedPolicyId

public void setHasAssociatedPolicyId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedPolicyId)
Sets hasAssociatedPolicyId attribute of the criteria Use this attribute to query for processes that has an associated policy with this id

Parameters:
hasAssociatedPolicyId - the id of the policy associated with the process

getHasAssociatedPolicyId

public com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedPolicyId()
Gets hasAssociatedPolicyId attribute of the criteria

Returns:
the hasAssociatedPolicyId attribute of the criteria

setHasAssociatedPolicyLabel

public void setHasAssociatedPolicyLabel(java.lang.String hasAssociatedPolicyLabel)
Sets hasAssociatedPolicyLabel attribute of the criteria Use this attribute to query for processes that has an associated policy with this label

Parameters:
hasAssociatedPolicyLabel - the label of the policy associated with the process

getHasAssociatedPolicyLabel

public java.lang.String getHasAssociatedPolicyLabel()
Gets hasAssociatedPolicyLabel attribute of the criteria

Returns:
the hasAssociatedPolicyLabel attribute of the criteria

setHasAssociatedSubprocessId

public void setHasAssociatedSubprocessId(com.oakgrovesystems.reactor.ReactorObjectId hasAssociatedSubprocessId)
Sets hasAssociatedSubprocessId attribute of the criteria Use this attribute to query for processes that has an associated subprocess with this id

Parameters:
hasAssociatedSubprocessId - the id of the subprocess associated with the process

getHasAssociatedSubprocessId

public com.oakgrovesystems.reactor.ReactorObjectId getHasAssociatedSubprocessId()
Gets hasAssociatedSubprocessId attribute of the criteria

Returns:
the hasAssociatedSubprocessId attribute of the criteria

setHasAssociatedSubprocessLabel

public void setHasAssociatedSubprocessLabel(java.lang.String hasAssociatedSubprocessLabel)
Sets hasAssociatedSubprocessLabel attribute of the criteria Use this attribute to query for processes that has an associated subprocess with this label

Parameters:
hasAssociatedSubprocessLabel - the label of the subprocess associated with the process

getHasAssociatedSubprocessLabel

public java.lang.String getHasAssociatedSubprocessLabel()
Gets hasAssociatedSubprocessLabel attribute of the criteria

Returns:
the hasAssociatedSubprocessLabel attribute of the criteria

setHasParentId

public void setHasParentId(com.oakgrovesystems.reactor.ReactorObjectId hasParentId)
Sets hasParentId attribute of the criteria Use this attribute to query for processes that has a parent process with this id

Parameters:
hasParentId - the id of the parrent process

getHasParentId

public com.oakgrovesystems.reactor.ReactorObjectId getHasParentId()
Gets hasParentId attribute of the criteria

Returns:
the hasParentId attribute of the criteria

setHasParentLabel

public void setHasParentLabel(java.lang.String hasParentLabel)
Sets hasParentLabel attribute of the criteria Use this attribute to query for processes that has a parent process with this label

Parameters:
hasParentLabel - the label of the parent process

getHasParentLabel

public java.lang.String getHasParentLabel()
Gets hasParentLabel attribute of the criteria

Returns:
the hasParentLabel attribute of the criteria

setMustBeRoot

public void setMustBeRoot(boolean mustBeRoot)
Sets mustBeRoot attribute of the criteria Use this criteria to query for rool level processes

Parameters:
mustBeRoot - must be true to query for root level processes

getMustBeRoot

public boolean getMustBeRoot()
Gets mustBeRoot attribute of the criteria

Returns:
true if selected else returns false

setDepth

public void setDepth(int depth)
Sets depth attribute of the criteria Use this attribute to set the depth of process tree to get. If set to -1 then all subprocesses are retrieved. If set to 0 then no subprocesses are retrieved. If set to 1 then only one level of subprocesses are retrieved and so on. By default this attribute is set to 0

Parameters:
depth - The depth of subprocesses to get

getDepth

public int getDepth()
Gets the depth attribute of the criteria

Returns:
the depth of subprocesses to get

setIncludeOperands

public void setIncludeOperands(boolean includeOperands)
Sets includeOperands attribute of the criteria Use this attribute to retrieve operands associated with a process

Parameters:
includeOperands - must be set to true to retrieve operands

getIncludeOperands

public boolean getIncludeOperands()
Gets includeOperands attribute of the criteria

Returns:
true if operands must be retrieved else returns false

setIncludeStatuses

public void setIncludeStatuses(boolean includeStatuses)
Sets includeStatuses attribute of the criteria Use this attribute to retrieve statuses associated with a process

Parameters:
includeStatuses - must be set to true to retrieve statuses

getIncludeStatuses

public boolean getIncludeStatuses()
Gets includeStatuses attribute of the criteria

Returns:
true if statuses must be retrieved else returns false

setIncludePolicies

public void setIncludePolicies(boolean includePolicies)
Sets includePolicies attribute of the criteria Use this attribute to retrieve policies associated with a process

Parameters:
includePolicies - must be set to true to retrieve policies

getIncludePolicies

public boolean getIncludePolicies()
Gets includePolicies attribute of the criteria

Returns:
true if policies must be retrieved else returns false

setIncludeParent

public void setIncludeParent(boolean includeParent)
Sets includeParent attribute of the criteria Use this attribute to retrieve parent of a process

Parameters:
includeParent - must be set to true to retrieve parent

getIncludeParent

public boolean getIncludeParent()
Gets includeParent attribute of the criteria

Returns:
true if parent must be retrieved else returns false

setGetThinProcesses

public void setGetThinProcesses(boolean getThinProcesses)
Sets getThin attribute of the criteria Use this attribute to disable deserialization of PCS-related data. This allows a higher-performance information-only query. Things like the portal might use this.


getGetThinProcesses

public boolean getGetThinProcesses()
Gets getThing attribute of the criteria

Returns:
true if avoid deserialization


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