All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.PersistentList

public interface PersistentList
Version:
3.2.0.2

Method Index

 o delete()

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

 o description()
Returns the description of the persistent list.
 o filter()
Returns the filter of the persistent list.
 o isEmpty()
Indicates whether no persistent list information is available.
 o name()
Returns the name of the persistent list.
 o ownerOfList()
Returns the user ID of the owner of the persistent list.
 o refresh()

This function/method refreshes the persistent list from the MQ Workflow execution server (action call).

 o setDescription(String)

This function/method sets the description of the persistent list to the specified value (action call).

 o setFilter(String)

This function/method sets the filter of the persistent list to the specified value (action call).

 o setSortCriteria(String)

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

 o setThreshold(Integer)

This function/method sets the threshold of the persistent list to the specified value (action call).

 o sortCriteria()
Returns the sort criteria of the persistent list.
 o threshold()
Returns the threshold of the persistent list.
 o type()
Returns the type of the persistent list, whether it is a public or private list.

Methods

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

Throws: FmcException
thrown if an API error or a communication error occurred.
 o description
 public abstract String description() throws FmcException
Returns the description of the persistent list.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o filter
 public abstract String filter() throws FmcException
Returns the filter of the persistent list.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o name
 public abstract String name() throws FmcException
Returns the name of the persistent list.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o ownerOfList
 public abstract 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.
 o sortCriteria
 public abstract String sortCriteria() throws FmcException
Returns the sort criteria of the persistent list.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o threshold
 public abstract Integer threshold() throws FmcException
Returns the threshold of the persistent list.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o type
 public abstract 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.
 o delete
 public abstract void delete() throws FmcException

This function/method 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.
 o refresh
 public abstract void refresh() throws FmcException

This function/method 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.
 o setDescription
 public abstract void setDescription(String description) throws FmcException

This function/method 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.
 o setFilter
 public abstract void setFilter(String newFilter) throws FmcException

This function/method 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.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o setSortCriteria
 public abstract void setSortCriteria(String sortCriteria) throws FmcException

This function/method 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.
 o setThreshold
 public abstract void setThreshold(Integer threshold) throws FmcException

This function/method 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.

All Packages  Class Hierarchy  This Package  Previous  Next  Index