com.ibm.itim.apps.workflow

Class WorkflowSearchResultsMO

java.lang.Object

com.ibm.itim.apps.workflow.WorkflowSearchResultsMO

All Implemented Interfaces:

java.io.Serializable

public class WorkflowSearchResultsMO
extends java.lang.Object
implements java.io.Serializable

Provides accessor methods to achieve pagination. This is a result of the search done on WorkflowSearchMO object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
com.ibm.itim.apps.impl.PlatformContextImpl	platform The platform will be changed to match the context of WokflowSearchMO.
javax.security.auth.Subject	subject The subject will be changed to match the context of WokflowSearchMO.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	beanExists() Returns true if the request manager bean is alive in method-ready state otherwise false.
java.util.Collection	getPage(int pageNo) Returns the specified page of the result set.
int	getPageCount() Returns the number of pages in the result set.
java.util.Collection	getResults() Returns all of the results.
void	reverseSortResults() Reverses the the sorting order of the search results.
void	sortResults(java.lang.String attribute, int order) Resorts by the given sort attribute and order (ascending vs.

Methods inherited from class java.lang.Object

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

Field Detail

subject

public javax.security.auth.Subject subject

The subject will be changed to match the context of WokflowSearchMO.

platform

public com.ibm.itim.apps.impl.PlatformContextImpl platform

The platform will be changed to match the context of WokflowSearchMO.

Constructor Detail

WorkflowSearchResultsMO

public WorkflowSearchResultsMO(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

getPageCount

public int getPageCount()
                 throws java.rmi.RemoteException,
                        ApplicationException,
                        java.lang.IllegalStateException

Returns the number of pages in the result set.

Returns:

Number of pages in the result set.

Throws:

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

ApplicationException - Thrown if an error occured trying to get page count.

java.lang.IllegalStateException - Thrown if the underlying bean is in unusable state.

getPage

public java.util.Collection getPage(int pageNo)
                             throws java.rmi.RemoteException,
                                    ApplicationException,
                                    java.lang.IllegalStateException

Returns the specified page of the result set.

Parameters:

pageNo - The number of the page to return.

Returns:

Collection of WorkflowProcess representing page of results.

Throws:

ApplicationException - Thrown if an error occured trying to get page.

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

java.lang.IllegalStateException - Thrown if the underlying bean is in unusable state.

See Also:

WorkflowProcess

getResults

public java.util.Collection getResults()
                                throws java.rmi.RemoteException,
                                       ApplicationException,
                                       java.lang.IllegalStateException

Returns all of the results.

Returns:

Collection of WorkflowProcess representing the complete result set.

Throws:

ApplicationException - Thrown if an error occured trying to get results.

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

java.lang.IllegalStateException - Thrown if the underlying bean is in unusable state.

See Also:

WorkflowProcess

sortResults

public void sortResults(java.lang.String attribute,
                        int order)
                 throws java.rmi.RemoteException,
                        ApplicationException,
                        java.lang.IllegalStateException

Resorts by the given sort attribute and order (ascending vs. descending).

Parameters:

attribute - Name of the attribute to sort by.

order - Enumeration of the order to sort by. Use WorkflowSearchMO.ASCENDING_SORT for ascending sort or WorkflowSearchMO.DESCENDING_SORT for descending sort.

Throws:

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

ApplicationException - Thrown if unable to resort. This is most likely caused by either an invalid sort attribute name or invalid sort order.

java.lang.IllegalStateException - Thrown if the underlying bean is in unusable state.

reverseSortResults

public void reverseSortResults()
                        throws java.rmi.RemoteException,
                               ApplicationException,
                               java.lang.IllegalStateException

Reverses the the sorting order of the search results.

Throws:

ApplicationException - Thrown if an error occured trying to reverse sort results.

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

java.lang.IllegalStateException - Thrown if the underlying bean is in unusable state.

beanExists

public boolean beanExists()
                   throws java.rmi.RemoteException

Returns true if the request manager bean is alive in method-ready state otherwise false.

Returns:

boolean true if bean exists otherwise false

Throws:

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