|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKWorkFlowActionListFed
This class represents an action list object.
Constructor Summary | |
DKWorkFlowActionListFed()
Default Constructor |
|
DKWorkFlowActionListFed(dkDatastore ds)
Constructs a work flow action list object with datastore reference |
|
DKWorkFlowActionListFed(dkDatastore ds,
java.lang.String name,
java.lang.String description)
Constructs a work flow action list object for Fed |
Method Summary | |
void |
add()
Deprecated. |
void |
addWorkFlowAction(dkWorkFlowAction actionObj)
Adds a new work flow action object to this work flow action list, memory only |
void |
checkin()
Deprecated. |
void |
checkout()
Deprecated. |
void |
del()
Deprecated. |
java.lang.String |
getCheckedOutUserid()
Deprecated. |
dkDatastore |
getDatastore()
Gets the datastore |
java.lang.String |
getDescription()
Gets the description of this work flow action list |
java.lang.String |
getItemId()
Deprecated. |
java.lang.String |
getName()
Gets the name of this work flow action list |
dkCollection |
getWorkFlowActions()
Deprecated. |
boolean |
isRetrieved()
|
java.lang.String[] |
listWorkFlowActionNames()
Gets a list of action names from persistent datastore |
dkCollection |
listWorkFlowActions()
Gets a list of actions in this action list |
void |
removeAllWorkFlowActions()
Remove all work flow actions from this work flow action list, memory only |
void |
removeWorkFlowAction(java.lang.String name)
Remove an action from this action list, memory only |
void |
retrieve()
Deprecated. |
void |
setDatastore(dkDatastore ds)
Sets the datastore object |
void |
setDescription(java.lang.String description)
Sets the description of this work flow action list |
void |
setItemId(java.lang.String id)
Deprecated. |
void |
setName(java.lang.String name)
sets the name for this work flow action list |
void |
setRetrieved(boolean isRetrieved)
|
void |
setWorkFlowActions(dkCollection actionColl)
Sets the collecction of dkWorkFlowAction objects to this action list, memory only |
void |
unlockCheckedOut()
Deprecated. |
void |
update()
Deprecated. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKWorkFlowActionListFed()
public DKWorkFlowActionListFed(dkDatastore ds)
ds
- Datastore objectDKException
- if the ds is nullpublic DKWorkFlowActionListFed(dkDatastore ds, java.lang.String name, java.lang.String description)
ds
- dkDatastorename
- name of the work flow action listdescription
- description of the work flow action listDKException
- if the ds is nullMethod Detail |
public dkDatastore getDatastore()
public void setDatastore(dkDatastore ds)
ds
- dkDatastore - datastore objectpublic boolean isRetrieved()
public void setRetrieved(boolean isRetrieved)
public java.lang.String getItemId()
public void setItemId(java.lang.String id)
id
- item id of the work flow action list objectpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- name of this work flow action listpublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- description of this work flow action listpublic void add() throws DKAlreadyExistException, DKException
DKAlreadyExistException
- if the work flow action already existsDKException
- when error occurs in the serverpublic void del() throws DKNotExistException, DKNotCheckedOutException, DKException
DKNotExitException
- if the work flow action list object does not existsDKException
- when error occurs in the serverpublic void update() throws DKNotExistException, DKNotCheckedOutException, DKException
DKNotExistException
- if the work flow action list object does not existsDKException
- when error occurs in the serverpublic void retrieve() throws DKNotExistException, DKException
DKNotExistException
- if the work flow action list does not existsDKException
- when error occurs in the serverpublic dkCollection listWorkFlowActions() throws DKException, java.lang.Exception
DKException
- when error occurs in the serverpublic java.lang.String[] listWorkFlowActionNames() throws DKException, java.lang.Exception
listWorkFlowActionNames
in interface dkWorkFlowActionList
DKException
- if error occurspublic dkCollection getWorkFlowActions() throws DKException, java.lang.Exception
getWorkFlowActions
in interface dkWorkFlowActionList
DKException
- when error occurs in the serverpublic void setWorkFlowActions(dkCollection actionColl) throws DKException
setWorkFlowActions
in interface dkWorkFlowActionList
DKException
- when error occurs in the serverpublic void addWorkFlowAction(dkWorkFlowAction actionObj) throws DKException
addWorkFlowAction
in interface dkWorkFlowActionList
actionObj
- the new work flow action to be addedDKException
- when error occurs in the serverpublic void removeWorkFlowAction(java.lang.String name) throws DKException
removeWorkFlowAction
in interface dkWorkFlowActionList
name
- the name of the work flow action object to be removedDKException
- when error occurs in the serverpublic void removeAllWorkFlowActions() throws DKException
removeAllWorkFlowActions
in interface dkWorkFlowActionList
DKException
- when error occurs in the serverpublic void checkin() throws DKNotCheckedOutException, DKException
checkin
in interface dkCheckableObject
DKNotCheckedOutException
- if the work flow action list is not checked out by the current user or been checked out by a different userDKException
- when error occurs in the serverpublic void checkout() throws DKAlreadyCheckedOutException, DKException
checkout
in interface dkCheckableObject
DKAlreadyCheckedOutException
- if the work flow action list has already been checked outDKException
- when error occurs in the serverpublic void unlockCheckedOut() throws DKNotCheckedOutException, DKException
unlockCheckedOut
in interface dkCheckableObject
DKNotCheckedOutException
- if the work flow action list is not checked outDKException
- when error occurs in the serverpublic java.lang.String getCheckedOutUserid() throws DKNotCheckedOutException, DKException
getCheckedOutUserid
in interface dkCheckableObject
DKNotCheckedOutException
- if the work flow action list is not checked outDKException
- when error occurs in the server
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |