|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public boolean isEmpty() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String description() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String filter() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String name() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String ownerOfList() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String persistentOid() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String sortCriteria() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.Integer threshold() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public TypeOfList type() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public void delete() throws FmcException
This API call deletes the specified persistent list from the MQ Workflow execution server (action call).
FmcException
- thrown if an API error or a communication error occurred.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.
FmcException
- thrown if an API error or a communication error occurred.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:
FmcException
- thrown if an API error or a communication error occurred.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().
FmcException
- thrown if an API error or a communication error occurred.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.
FmcException
- thrown if an API error or a communication error occurred.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.
FmcException
- thrown if an API error or a communication error occurred.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |