com.ibm.itim.apps.workflow
Class WorkflowSearchMO

java.lang.Object
  |
  +--com.ibm.itim.apps.workflow.WorkflowSearchMO

public class WorkflowSearchMO

extends java.lang.Object

Provides the ability to configure and execute search for workflow processes.

Field Summary

static int	ASCENDING_SORT Constant identifying a low to high sort order.
static int	DESCENDING_SORT Constant identifying a high to low sort order.

Constructor Summary

WorkflowSearchMO(PlatformContext platform, javax.security.auth.Subject subject)
Constructs the the managed object with a platform context and a subject.

Method Summary

WorkflowSearchResultsMO	execute() Executes the search using the configured parameters.
void	execute(WorkflowSearchResultsMO results) Executes the search using the configured parameters.
java.util.Locale	getLocale() Returns the user's locale.
java.lang.String	getSortAttribute() Returns the name of the attribute to sort by.
int	getSortOrder() Returns the sort order for the result set.
WorkflowQueryStatement	getStatement() Returns the workflow specific query statement being executed.
boolean	isPaging() Returns true if the result set should be paginated.
void	setLocale(java.util.Locale locale) Sets the user's locale.
void	setPaging(boolean toggle) Toggles pagination on/off for the request.
void	setSortAttribute(java.lang.String sortAttribute) Sets the name of the attribute to sort by.
void	setSortOrder(int sortOrder) Sets the sort order for the result set.
void	setStatement(WorkflowQueryStatement statement) Sets the workflow specific query statement to execute.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ASCENDING_SORT

public static int ASCENDING_SORT

Constant identifying a low to high sort order.

DESCENDING_SORT

public static int DESCENDING_SORT

Constant identifying a high to low sort order.

Constructor Detail

WorkflowSearchMO

public WorkflowSearchMO(PlatformContext platform,
                        javax.security.auth.Subject subject)

Constructs the the managed object with a platform context and a subject.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Subject representing the authenticated caller.

Method Detail

execute

public WorkflowSearchResultsMO execute()
                                throws java.rmi.RemoteException,
                                       ApplicationException

Executes the search using the configured parameters. Note, not all objects that meet the search parameters will be accessible by the client. Those objects will not placed in the result set and no AuthorizationException will be thrown.

Returns:

WorkflowSearchResultsMO provides accessor methods to retrieve results (Collection of WorkflowProcess) of the search.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if unable to execute the search. This is most likely caused by an invalid parameter in the request.

execute

public void execute(WorkflowSearchResultsMO results)
             throws java.rmi.RemoteException,
                    ApplicationException

Executes the search using the configured parameters. Note, not all objects that meet the search parameters will be accessible by the client. Those objects will not placed in the result set and no AuthorizationException will be thrown.

Parameters:

results - WorkflowSearchResultsMO to hold the results of the search. Note, if the WorkflowSearchResultsMO object was constructed using a different user context, that context will be changed to match the context of this object.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if unable to execute the search. This is most likely caused by an invalid parameter in the request.

setLocale

public void setLocale(java.util.Locale locale)

Sets the user's locale.

Parameters:

locale - the user's Locale.

getLocale

public java.util.Locale getLocale()

Returns the user's locale.

Returns:

locale the user's Locale.

setStatement

public void setStatement(WorkflowQueryStatement statement)

Sets the workflow specific query statement to execute.

Parameters:

statement - WorkflowQueryStatement defining the query logic to execute. This parameter should be an instance of ProvisioningQueryStatement

getStatement

public WorkflowQueryStatement getStatement()

Returns the workflow specific query statement being executed.

Returns:

WorkflowQueryStatement defining the query logic to execute.

setSortAttribute

public void setSortAttribute(java.lang.String sortAttribute)

Sets the name of the attribute to sort by.

Parameters:

sortAttribute - The name of the attribute to sort by.

getSortAttribute

public java.lang.String getSortAttribute()

Returns the name of the attribute to sort by.

Returns:

sortAttribute name of the attribute to sort by; null if it is not set.

setPaging

public void setPaging(boolean toggle)

Toggles pagination on/off for the request. Default is true. Used to override the default and obtain an entire result set with this request.

Parameters:

toggle - true/false option to paginate the result set.

isPaging

public boolean isPaging()

Returns true if the result set should be paginated.

Returns:

true if the result set should be paginated.

getSortOrder

public int getSortOrder()

Returns the sort order for the result set. One of: ASCENDING_SORT or DESCENDING_SORT

Returns:

result set sort order.

setSortOrder

public void setSortOrder(int sortOrder)

Sets the sort order for the result set. Must be one of: ASCENDING_SORT or DESCENDING_SORT

Parameters:

sortOrder - result set sort order.