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

See Also:
Serialized Form

Field Summary
 com.ibm.itim.apps.impl.PlatformContextImpl platform
           
 javax.security.auth.Subject subject
           
 
Constructor Summary
WorkflowSearchResultsMO(PlatformContext platform, javax.security.auth.Subject subject)
          Constructs the the managed object with a platform context and a subject.
 
Method Summary
 boolean beanExists()
          Returns true if the request manager bean is "alive" i.e.
 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

platform

public com.ibm.itim.apps.impl.PlatformContextImpl platform
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.

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 value objects representing page of results.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.

getResults

public java.util.Collection getResults()
                                throws java.rmi.RemoteException,
                                       ApplicationException,
                                       java.lang.IllegalStateException
Returns all of the results.
Returns:
Collection of WorkflowProcess value objects representing the complete result set.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.

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. Value may be either SearchRequest.ASCENDING_SORT or SearchRequest.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.

reverseSortResults

public void reverseSortResults()
                        throws java.rmi.RemoteException,
                               ApplicationException,
                               java.lang.IllegalStateException
Reverses the the sorting order of the search results.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.

beanExists

public boolean beanExists()
                   throws java.rmi.RemoteException
Returns true if the request manager bean is "alive" i.e. in method-ready state and false otherwise.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.