|
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.DKWorkPacketFed
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKWorkPacketFed()
Default Constructor |
|
DKWorkPacketFed(dkDatastore ds)
Constructor with dkDatastore object reference |
|
DKWorkPacketFed(dkDatastore ds,
java.lang.String item_id)
Constructor with dkDatastore object reference |
|
DKWorkPacketFed(dkDatastore ds,
java.lang.String name,
java.lang.String description)
Construct a new instance of DKWorkPacketFed with dkDatastore object reference, name, and description |
Method Summary | |
void |
add()
Adds this work packet object into the persistent store |
void |
addItem(DKPid pid)
Adds new item to this work packet - memory function only |
void |
addItem(java.lang.String pidString)
Adds new item to this work packet - memory function only |
void |
checkin()
Check in this work packet to persistent datastore |
void |
checkout()
Check out this work packet from persistent datastore |
void |
del()
Deletes this work packet from the persistent store |
java.lang.String |
getCheckedOutUserid()
Gets the checked out userid of this work packet |
dkDatastore |
getDatastore()
Gets the datastore |
java.lang.String |
getDescription()
Gets the description of this work packet |
java.lang.String |
getItemId()
Gets unique item id of this work packet |
java.lang.String[] |
getItemIDs()
Get an array of pid strings of the DKPid objects in this work packet |
dkCollection |
getItems()
Gets a collection of DKPid objects from this work packet |
java.lang.String |
getName()
Gets the name of this work packet |
int |
getPriority()
Gets the priority of the work packet |
DKTimestamp |
getTimestamp()
Gets the timestamp of this work packet |
java.lang.String |
getUserid()
Gets userid of this work packet |
java.lang.String |
getWFTemplateName()
Gets the work flow template name of this work flow packet |
boolean |
isAuthorized(int privilege)
|
int |
itemsCount()
Gets the number of items in this work packet |
void |
removeItem(DKPid pid)
Removes item from this work packet - memory function only |
void |
removeItem(java.lang.String pidString)
Removes item from this work packet - memory function only |
void |
retrieve()
Retrieves this work packet from the persistent store |
void |
setDatastore(dkDatastore ds)
Sets datastore object |
void |
setDescription(java.lang.String description)
Sets the description of this work packet |
void |
setItemId(java.lang.String id)
Sets the unique item id for this work packet |
void |
setName(java.lang.String name)
Sets the name for this work packet |
void |
setPriority(int priority)
Sets the priority of the work packet |
void |
setTimestamp(DKTimestamp ts)
Sets the timestamp of this work packet |
void |
setUserid(java.lang.String uid)
Sets the userid of this work packet |
void |
setWFTemplateName(java.lang.String name)
Sets the work flow template name of this work flow packet |
void |
unlockCheckedOut()
Unlocks this work packet, which is currently checked out, from the persistent datastore |
void |
update()
Updates this work packet in the persistent store |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKWorkPacketFed()
public DKWorkPacketFed(dkDatastore ds)
ds
- datastore Objectpublic DKWorkPacketFed(dkDatastore ds, java.lang.String item_id)
ds
- datastore Objectpublic DKWorkPacketFed(dkDatastore ds, java.lang.String name, java.lang.String description)
ds
- datastore objectname
- name of this work packet objectdescription
- description of this work packet objectMethod Detail |
public dkDatastore getDatastore()
public void setDatastore(dkDatastore ds)
ds
- the datastore object associated with this work packet objectpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- name of the work packet objectpublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- description of the work packet objectpublic java.lang.String getItemId()
public void setItemId(java.lang.String id)
id
- id of the work packet objectpublic java.lang.String getUserid()
getUserid
in interface dkWorkPacket
public void setUserid(java.lang.String uid)
setUserid
in interface dkWorkPacket
uid
- userid of the work packet objectpublic DKTimestamp getTimestamp()
getTimestamp
in interface dkWorkPacket
public void setTimestamp(DKTimestamp ts)
setTimestamp
in interface dkWorkPacket
ts
- timestamp of the work packet objectpublic int getPriority()
getPriority
in interface dkWorkPacket
public void setPriority(int priority)
setPriority
in interface dkWorkPacket
priority
- priority of the work packet objectpublic java.lang.String getWFTemplateName()
getWFTemplateName
in interface dkWorkPacket
public void setWFTemplateName(java.lang.String name)
setWFTemplateName
in interface dkWorkPacket
name
- name of the work flow template associated with the work packet objectpublic void add() throws DKAlreadyExistException, DKException
DKAlreadyExistException
- if the work packet already existsDKException
- when error occurs in the serverpublic void del() throws DKNotExistException, DKNotCheckedOutException, DKException
DKNotExitException
- if the work packet object does not existsDKException
- when error occurs in the serverpublic void update() throws DKNotExistException, DKNotCheckedOutException, DKException
DKNotExistException
- if the work packet object does not existsDKException
- when error occurs in the serverpublic void retrieve() throws DKNotExistException, DKException
DKNotExistException
- if the work packet does not existsDKException
- when error occurs in the serverpublic void addItem(DKPid pid) throws DKException
addItem
in interface dkWorkPacket
pid
- a DKPid object to be added to the work packet objectDKException
- if error occurs in the serverpublic void addItem(java.lang.String pidString) throws DKException
addItem
in interface dkWorkPacket
pidString
- the pid string of the DKPid object to be added to the work packet objectDKException
- if error occurs in the serverpublic void removeItem(DKPid pid) throws DKException
removeItem
in interface dkWorkPacket
pid
- a DKPid object to be removed from the work packet objectDKException
- if error occurs in the serverpublic void removeItem(java.lang.String pidString) throws DKException
removeItem
in interface dkWorkPacket
pidString
- the pid string of the DKPid object to be removed to the work packet objectDKException
- if error occurs in the serverpublic java.lang.String[] getItemIDs() throws DKException, java.lang.Exception
getItemIDs
in interface dkWorkPacket
DKException
- if error occurs in the serverpublic dkCollection getItems() throws DKException, java.lang.Exception
getItems
in interface dkWorkPacket
DKException
- if error occurs in the serverpublic int itemsCount() throws DKException, java.lang.Exception
DKException
- if error occurs in the serverpublic void checkin() throws DKNotCheckedOutException, DKException
checkin
in interface dkCheckableObject
DKNotCheckedOutException
- if the work packet 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 DKNotExistException, DKAlreadyCheckedOutException, DKException
checkout
in interface dkCheckableObject
DKAlreadyCheckedOutException
- if the work packet has already been checked outDKException
- when error occurs in the serverpublic void unlockCheckedOut() throws DKNotCheckedOutException, DKException
unlockCheckedOut
in interface dkCheckableObject
DKNotCheckedOutException
- if the work packet 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 packet is not checked outDKException
- when error occurs in the serverpublic boolean isAuthorized(int privilege) throws DKException
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |