com.ibm.workflow.api
Interface PersistentList

All Known Subinterfaces:
ActivityInstanceList, ProcessInstanceList, ProcessTemplateList, WorkList

public interface PersistentList


Method Summary
 void delete()
          This API call deletes the specified persistent list from the MQ Workflow execution server (action call).
 java.lang.String description()
          Returns the description of the persistent list.
 java.lang.String filter()
          Returns the filter of the persistent list.
 boolean isEmpty()
          Indicates whether no persistent list information is available.
 java.lang.String name()
          Returns the name of the persistent list.
 java.lang.String ownerOfList()
          Returns the user ID of the owner of the persistent list.
 java.lang.String persistentOid()
          Returns a representation of the object identification of the persistent list.
 void refresh()
          This API call refreshes the persistent list from the MQ Workflow execution server (action call).
 void setDescription(java.lang.String description)
          This API call sets the description of the persistent list to the specified value (action call).
 void setFilter(java.lang.String newFilter)
          This API call sets the filter of the persistent list to the specified value (action call).
 void setSortCriteria(java.lang.String sortCriteria)
          This API call sets the sort criteria of the persistent list to the specified value (action call).
 void setThreshold(java.lang.Integer threshold)
          This API call sets the threshold of the persistent list to the specified value (action call).
 java.lang.String sortCriteria()
          Returns the sort criteria of the persistent list.
 java.lang.Integer threshold()
          Returns the threshold of the persistent list.
 TypeOfList type()
          Returns the type of the persistent list, whether it is a public or private list.
 

Method Detail

isEmpty

public boolean isEmpty()
                throws FmcException
Indicates whether no persistent list information is available.

Throws:
FmcException - thrown if an API error or a communication error occurred.

description

public java.lang.String description()
                             throws FmcException
Returns the description of the persistent list.

Throws:
FmcException - thrown if an API error or a communication error occurred.

filter

public java.lang.String filter()
                        throws FmcException
Returns the filter of the persistent list.

Throws:
FmcException - thrown if an API error or a communication error occurred.

name

public java.lang.String name()
                      throws FmcException
Returns the name of the persistent list.

Throws:
FmcException - thrown if an API error or a communication error occurred.

ownerOfList

public java.lang.String ownerOfList()
                             throws FmcException
Returns the user ID of the owner of the persistent list.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentOid

public java.lang.String persistentOid()
                               throws FmcException
Returns a representation of the object identification of the persistent list.

Throws:
FmcException - thrown if an API error or a communication error occurred.

sortCriteria

public java.lang.String sortCriteria()
                              throws FmcException
Returns the sort criteria of the persistent list.

Throws:
FmcException - thrown if an API error or a communication error occurred.

threshold

public java.lang.Integer threshold()
                            throws FmcException
Returns the threshold of the persistent list.

Throws:
FmcException - thrown if an API error or a communication error occurred.

type

public TypeOfList type()
                throws FmcException
Returns the type of the persistent list, whether it is a public or private list.

Throws:
FmcException - thrown if an API error or a communication error occurred.

delete

public void delete()
            throws FmcException

This API call deletes the specified persistent list from the MQ Workflow execution server (action call).

Throws:
FmcException - thrown if an API error or a communication error occurred.

refresh

public void refresh()
             throws FmcException

This API call refreshes the persistent list from the MQ Workflow execution server (action call).

All information about the persistent list is retrieved, for example, its description, its filter, or its sort criteria.

Throws:
FmcException - thrown if an API error or a communication error occurred.

setDescription

public void setDescription(java.lang.String description)
                    throws FmcException

This API call sets the description of the persistent list to the specified value (action call).

If no description is provided, the description of the persistent list is erased.

The following rules apply for specifying a persistent list description:

Throws:
FmcException - thrown if an API error or a communication error occurred.

setFilter

public void setFilter(java.lang.String newFilter)
               throws FmcException

This API call sets the filter of the persistent list to the specified value (action call).

If no filter is provided, the current filter of the persistent list is erased. This means that all objects authorized for will be selected via this list.

Refer to the appropriate list creation for a description of a valid filter syntax. For example, see CreateWorklist().

Throws:
FmcException - thrown if an API error or a communication error occurred.

setSortCriteria

public void setSortCriteria(java.lang.String sortCriteria)
                     throws FmcException

This API call sets the sort criteria of the persistent list to the specified value (action call).

If no sort criteria are provided, the current sort criteria of the persistent list are erased. This means that objects selected via this list will not be sorted.

Refer to the appropriate list creation for a description of a valid sort criteria syntax.

Throws:
FmcException - thrown if an API error or a communication error occurred.

setThreshold

public void setThreshold(java.lang.Integer threshold)
                  throws FmcException

This API call sets the threshold of the persistent list to the specified value (action call).

If no threshold is provided, the threshold of the persistent list is erased. This means that all objects contained in the list will be provided when queried.

Throws:
FmcException - thrown if an API error or a communication error occurred.


© Copyright IBM Corporation 1999, 2008. All Rights Reserved.