Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkPacketFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkPacketFed
All Implemented Interfaces:
dkCheckableObject, DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, dkWorkPacket, java.io.Serializable

public class DKWorkPacketFed
extends java.lang.Object
implements dkWorkPacket, DKConstantFed, DKMessageIdFed, java.io.Serializable

See Also:
Serialized Form

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

DKWorkPacketFed

public DKWorkPacketFed()
Default Constructor

DKWorkPacketFed

public DKWorkPacketFed(dkDatastore ds)
Constructor with dkDatastore object reference
Parameters:
ds - datastore Object

DKWorkPacketFed

public DKWorkPacketFed(dkDatastore ds,
                       java.lang.String item_id)
Constructor with dkDatastore object reference
Parameters:
ds - datastore Object

DKWorkPacketFed

public DKWorkPacketFed(dkDatastore ds,
                       java.lang.String name,
                       java.lang.String description)
Construct a new instance of DKWorkPacketFed with dkDatastore object reference, name, and description
Parameters:
ds - datastore object
name - name of this work packet object
description - description of this work packet object
Method Detail

getDatastore

public dkDatastore getDatastore()
Gets the datastore
Returns:
the datastore object associated with the work packet object

setDatastore

public void setDatastore(dkDatastore ds)
Sets datastore object
Parameters:
ds - the datastore object associated with this work packet object

getName

public java.lang.String getName()
Gets the name of this work packet
Returns:
the name of the work packet object

setName

public void setName(java.lang.String name)
Sets the name for this work packet
Parameters:
name - name of the work packet object

getDescription

public java.lang.String getDescription()
Gets the description of this work packet
Returns:
the description of the work packet object

setDescription

public void setDescription(java.lang.String description)
Sets the description of this work packet
Parameters:
description - description of the work packet object

getItemId

public java.lang.String getItemId()
Gets unique item id of this work packet
Returns:
the id of the work packet object

setItemId

public void setItemId(java.lang.String id)
Sets the unique item id for this work packet
Parameters:
id - id of the work packet object

getUserid

public java.lang.String getUserid()
Gets userid of this work packet
Specified by:
getUserid in interface dkWorkPacket
Returns:
the uid of the work packet object

setUserid

public void setUserid(java.lang.String uid)
Sets the userid of this work packet
Specified by:
setUserid in interface dkWorkPacket
Parameters:
uid - userid of the work packet object

getTimestamp

public DKTimestamp getTimestamp()
Gets the timestamp of this work packet
Specified by:
getTimestamp in interface dkWorkPacket
Returns:
the timestamp of the work packet object

setTimestamp

public void setTimestamp(DKTimestamp ts)
Sets the timestamp of this work packet
Specified by:
setTimestamp in interface dkWorkPacket
Parameters:
ts - timestamp of the work packet object

getPriority

public int getPriority()
Gets the priority of the work packet
Specified by:
getPriority in interface dkWorkPacket
Returns:
the priority of the work packet

setPriority

public void setPriority(int priority)
Sets the priority of the work packet
Specified by:
setPriority in interface dkWorkPacket
Parameters:
priority - priority of the work packet object

getWFTemplateName

public java.lang.String getWFTemplateName()
Gets the work flow template name of this work flow packet
Specified by:
getWFTemplateName in interface dkWorkPacket
Returns:
a work flow template name

setWFTemplateName

public void setWFTemplateName(java.lang.String name)
Sets the work flow template name of this work flow packet
Specified by:
setWFTemplateName in interface dkWorkPacket
Parameters:
name - name of the work flow template associated with the work packet object

add

public void add()
         throws DKAlreadyExistException,
                DKException
Adds this work packet object into the persistent store
Throws:
DKAlreadyExistException - if the work packet already exists
DKException - when error occurs in the server

del

public void del()
         throws DKNotExistException,
                DKNotCheckedOutException,
                DKException
Deletes this work packet from the persistent store
Throws:
DKNotExitException - if the work packet object does not exists
DKException - when error occurs in the server

update

public void update()
            throws DKNotExistException,
                   DKNotCheckedOutException,
                   DKException
Updates this work packet in the persistent store
Throws:
DKNotExistException - if the work packet object does not exists
DKException - when error occurs in the server

retrieve

public void retrieve()
              throws DKNotExistException,
                     DKException
Retrieves this work packet from the persistent store
Throws:
DKNotExistException - if the work packet does not exists
DKException - when error occurs in the server

addItem

public void addItem(DKPid pid)
             throws DKException
Adds new item to this work packet - memory function only
Specified by:
addItem in interface dkWorkPacket
Parameters:
pid - a DKPid object to be added to the work packet object
Throws:
DKException - if error occurs in the server

addItem

public void addItem(java.lang.String pidString)
             throws DKException
Adds new item to this work packet - memory function only
Specified by:
addItem in interface dkWorkPacket
Parameters:
pidString - the pid string of the DKPid object to be added to the work packet object
Throws:
DKException - if error occurs in the server

removeItem

public void removeItem(DKPid pid)
                throws DKException
Removes item from this work packet - memory function only
Specified by:
removeItem in interface dkWorkPacket
Parameters:
pid - a DKPid object to be removed from the work packet object
Throws:
DKException - if error occurs in the server

removeItem

public void removeItem(java.lang.String pidString)
                throws DKException
Removes item from this work packet - memory function only
Specified by:
removeItem in interface dkWorkPacket
Parameters:
pidString - the pid string of the DKPid object to be removed to the work packet object
Throws:
DKException - if error occurs in the server

getItemIDs

public java.lang.String[] getItemIDs()
                              throws DKException,
                                     java.lang.Exception
Get an array of pid strings of the DKPid objects in this work packet
Specified by:
getItemIDs in interface dkWorkPacket
Throws:
DKException - if error occurs in the server

getItems

public dkCollection getItems()
                      throws DKException,
                             java.lang.Exception
Gets a collection of DKPid objects from this work packet
Specified by:
getItems in interface dkWorkPacket
Throws:
DKException - if error occurs in the server

itemsCount

public int itemsCount()
               throws DKException,
                      java.lang.Exception
Gets the number of items in this work packet
Throws:
DKException - if error occurs in the server

checkin

public void checkin()
             throws DKNotCheckedOutException,
                    DKException
Check in this work packet to persistent datastore
Specified by:
checkin in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work packet is not checked out by the current user or been checked out by a different user
DKException - when error occurs in the server

checkout

public void checkout()
              throws DKNotExistException,
                     DKAlreadyCheckedOutException,
                     DKException
Check out this work packet from persistent datastore
Specified by:
checkout in interface dkCheckableObject
Throws:
DKAlreadyCheckedOutException - if the work packet has already been checked out
DKException - when error occurs in the server

unlockCheckedOut

public void unlockCheckedOut()
                      throws DKNotCheckedOutException,
                             DKException
Unlocks this work packet, which is currently checked out, from the persistent datastore
Specified by:
unlockCheckedOut in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work packet is not checked out
DKException - when error occurs in the server

getCheckedOutUserid

public java.lang.String getCheckedOutUserid()
                                     throws DKNotCheckedOutException,
                                            DKException
Gets the checked out userid of this work packet
Specified by:
getCheckedOutUserid in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work packet is not checked out
DKException - when error occurs in the server

isAuthorized

public boolean isAuthorized(int privilege)
                     throws DKException

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.