ProcessInstanceQuery Class

com.bea.wli.management.runtime
ProcessInstanceQuery Class

public class ProcessInstanceQuery

    extends Object
    implements Serializable

Represents a query to obtain information about process instances.

Related Topics

ProcessRuntimeMBean


Hierarchy
Object
  ProcessInstanceQuery
All Implemented Interfaces

Serializable

Constructor Summary

ProcessInstanceQuery()

Constructor for creating an empty query.
ProcessInstanceQuery(String serviceURI, ProcessStatus status)

Convenience constructor for querying instances of the given service that are in the given state.
ProcessInstanceQuery(String serviceURI, ProcessStatus status, long startTimeMin, long startTimeMax, long statusChangeTimeMin, long statusChangeTimeMax, long elapsedMin, long elapsedMax, String label, boolean aboveSLA, boolean aboveSLAWarning, int count)

ProcessInstanceQuery(String instanceId)

Constructor for querying a single process instance
 

Method Summary

public boolean
equals(Object o)
public int
getCount()
public long
getElapsedMax()
public long
getElapsedMin()
public String
getInstanceId()
Returns the instance (conversation) id component of the query.
public String
getLabel()
public String
getServiceURI()
Returns the serviceURI to filter on.
public long
getStartTimeMax()
public long
getStartTimeMin()
public ProcessStatus[]
getStatus()
Returns the array ProcessStatus object to filter on.
public long
getStatusChangeTimeMax()
public long
getStatusChangeTimeMin()
public int
hashCode()
public boolean
isAboveSLA()
public boolean
isAboveSLAWarning()
public boolean
isSingleInstanceQuery()
Returns true if the query filters only on the instance (coversation) id.
public void
setAboveSLA(boolean aboveSLA)
Allows filtering instances based on their SLA status.
public void
setAboveSLAWarning(boolean aboveSLAWarning)
Allows filtering instances based on their SLA Warning Threshold status.
public void
setCount(int count)
Sets the maximum number of results to return.
public void
setElapsedMax(long elapsedMax)
Sets the maximum elapsed time for the instances that are returned.
public void
setElapsedMin(long elapsedMin)
Sets the minimum elapsed time for the instances that are returned.
public void
setInstanceId(String instanceId)
Sets the instance (conversation) id component of the query.
public void
setLabel(String label)
Adds a predicate to the query so that only instances whose process label containing this value are returned.
public void
setServiceURI(String serviceURI)
Sets the serviceURI predicate so that only instances of a particular process are returned.
public void
setStartTimeMax(long startTimeMax)
Adds a predicate to the query so that only instances that started before the given time are returned.
public void
setStartTimeMin(long startTimeMin)
Adds a predicate to the query so that only instances that started after the given time are returned.
public void
setStatus(ProcessStatus[] status)
Sets the process status predicate so that only instances that are in one of the states are returned.
public void
setStatus(ProcessStatus status)
Convenience method for query instances that are in the given state.
public void
setStatusChangeTimeMax(long statusChangeTimeMax)
Adds a predicate to the query so that only instances that has aborted, completed, or terminated before the given time are returned.
public void
setStatusChangeTimeMin(long statusChangeTimeMin)
Adds a predicate to the query so that only instances that has aborted, completed, or terminated after the given time are returned.
public String
toString()
 
Methods from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
   

Constructor Detail

ProcessInstanceQuery

public ProcessInstanceQuery()
Constructor for creating an empty query. An empty query returns all the instances

ProcessInstanceQuery

public ProcessInstanceQuery(String serviceURI, 
                            ProcessStatus status)
Convenience constructor for querying instances of the given service that are in the given state.

ProcessInstanceQuery

public ProcessInstanceQuery(String serviceURI, 
                            ProcessStatus[] status, 
                            long startTimeMin, 
                            long startTimeMax, 
                            long statusChangeTimeMin, 
                            long statusChangeTimeMax, 
                            long elapsedMin, 
                            long elapsedMax, 
                            String label, 
                            boolean aboveSLA, 
                            boolean aboveSLAWarning, 
                            int count)

ProcessInstanceQuery

public ProcessInstanceQuery(String instanceId)
Constructor for querying a single process instance
 

Method Detail

equals(Object) Method

public boolean equals(Object o)
Overrides
Object.equals(Object)

getCount() Method

public int getCount()

getElapsedMax() Method

public long getElapsedMax()

getElapsedMin() Method

public long getElapsedMin()

getInstanceId() Method

public String getInstanceId()
Returns the instance (conversation) id component of the query. If instance id is set all other predicates are ignored.


getLabel() Method

public String getLabel()

getServiceURI() Method

public String getServiceURI()
Returns the serviceURI to filter on. Returns null if the query does not filter based on service URI.


getStartTimeMax() Method

public long getStartTimeMax()

getStartTimeMin() Method

public long getStartTimeMin()

getStatus() Method

public ProcessStatus[] getStatus()
Returns the array ProcessStatus object to filter on. Returns null if the query does not filter based on the process status.


getStatusChangeTimeMax() Method

public long getStatusChangeTimeMax()

getStatusChangeTimeMin() Method

public long getStatusChangeTimeMin()

hashCode() Method

public int hashCode()
Overrides
Object.hashCode()

isAboveSLA() Method

public boolean isAboveSLA()

isAboveSLAWarning() Method

public boolean isAboveSLAWarning()

isSingleInstanceQuery() Method

public boolean isSingleInstanceQuery()
Returns true if the query filters only on the instance (coversation) id.


setAboveSLA(boolean) Method

public void setAboveSLA(boolean aboveSLA)
Allows filtering instances based on their SLA status. A true value causes instances that exceeded their SLAs to be returned. default value for this component is false. This method can be used in conjunction with the ProcessInstanceQuery.setAboveSLAWarning(boolean) to return:

  • all instances that exceeded their SLAs but not SLA Warning Thresholds.
  • all instances that exceeded their SLAs or SLA Warning Thresholds.
  • all instances that exceeded their SLA Warning Threshold but not SLA


    setAboveSLAWarning(boolean) Method

    public void setAboveSLAWarning(boolean aboveSLAWarning)
    
    Allows filtering instances based on their SLA Warning Threshold status. A true value causes instances that exceeded their SLA Warning Thresholds to be returned. default value for this component is false. This method can be used in conjunction with the ProcessInstanceQuery.setAboveSLA(boolean) to return:

  • all instances that exceeded their SLAs but not SLA Warning Thresholds.
  • all instances that exceeded their SLAs or SLA Warning Thresholds.
  • all instances that exceeded their SLA Warning Threshold but not SLA


    setCount(int) Method

    public void setCount(int count)
    
    Sets the maximum number of results to return.


    setElapsedMax(long) Method

    public void setElapsedMax(long elapsedMax)
    
    Sets the maximum elapsed time for the instances that are returned. The default value for this component is Long.MAX_VALUE

    Parameters

    elapsedMax
    maximum elapsed time in milliseconds

    setElapsedMin(long) Method

    public void setElapsedMin(long elapsedMin)
    
    Sets the minimum elapsed time for the instances that are returned. The default value for this component is 0

    Parameters

    elapsedMin
    minimum elapsed time in milliseconds

    setInstanceId(String) Method

    public void setInstanceId(String instanceId)
    
    Sets the instance (conversation) id component of the query. This resets all other predicates that may have been set previously.


    setLabel(String) Method

    public void setLabel(String label)
    
    Adds a predicate to the query so that only instances whose process label containing this value are returned.


    setServiceURI(String) Method

    public void setServiceURI(String serviceURI)
    
    Sets the serviceURI predicate so that only instances of a particular process are returned. A null value is allowed and indicates all processes, effectively disabling the filtering on serviceURI.


    setStartTimeMax(long) Method

    public void setStartTimeMax(long startTimeMax)
    
    Adds a predicate to the query so that only instances that started before the given time are returned. A value of Long.MAX_VALUE effectively disabled this predicate. The default value for this component is Long.MAX_VALUE

    Parameters

    startTimeMax
    time in milliseconds

    setStartTimeMin(long) Method

    public void setStartTimeMin(long startTimeMin)
    
    Adds a predicate to the query so that only instances that started after the given time are returned. A value of 0 effectively disables this predicate. The default value for this component is 0

    Parameters

    startTimeMin
    time in milliseconds

    setStatus(ProcessStatus[]) Method

    public void setStatus(ProcessStatus[] status)
    
    Sets the process status predicate so that only instances that are in one of the states are returned. A null value or an empty array indicates that process status is not considered when querying instances.


    setStatus(ProcessStatus) Method

    public void setStatus(ProcessStatus status)
    
    Convenience method for query instances that are in the given state.


    setStatusChangeTimeMax(long) Method

    public void setStatusChangeTimeMax(long statusChangeTimeMax)
    
    Adds a predicate to the query so that only instances that has aborted, completed, or terminated before the given time are returned. A value of Long.MAX_VALUE effectively disables this predicate. The default value for this component is Long.MAX_VALUE


    setStatusChangeTimeMin(long) Method

    public void setStatusChangeTimeMin(long statusChangeTimeMin)
    
    Adds a predicate to the query so that only instances that has aborted, completed, or terminated after the given time are returned. A value of 0 effectively disables this predicate. The default value for this component is 0

    Parameters

    statusChangeTimeMin
    time in milliseconds

    toString() Method

    public String toString()
    
    Overrides
    Object.toString()