Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkWorkPacket

All Superinterfaces:
dkCheckableObject
All Known Implementing Classes:
DKWorkPacketFed

public interface dkWorkPacket
extends dkCheckableObject


Method Summary
 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
 java.lang.String[] getItemIDs()
          returns an array of pidString from this work packet
 dkCollection getItems()
          returns a collection DKDDO from this work packet, not yet retrieved contents - shell only
 int getPriority()
          gets the priority
 DKTimestamp getTimestamp()
          gets the timestamp
 java.lang.String getUserid()
          gets userid that created this work packet
 java.lang.String getWFTemplateName()
          gets the workflow template name
 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 setPriority(int priority)
          sets the priority
 void setTimestamp(DKTimestamp ts)
          sets the timestamp
 void setUserid(java.lang.String uid)
          sets the userid who created this work packet
 void setWFTemplateName(java.lang.String name)
          sets the workflow template name
 
Methods inherited from interface com.ibm.mm.sdk.common.dkCheckableObject
checkin, checkout, getCheckedOutUserid, unlockCheckedOut
 

Method Detail

getUserid

public java.lang.String getUserid()
                           throws DKException,
                                  java.lang.Exception
gets userid that created this work packet
Returns:
user id of this work packet

setUserid

public void setUserid(java.lang.String uid)
               throws DKException,
                      java.lang.Exception
sets the userid who created this work packet
Parameters:
uid - the user id of the work packet

getTimestamp

public DKTimestamp getTimestamp()
                         throws DKException,
                                java.lang.Exception
gets the timestamp
Returns:
the time stamp of the work packet

setTimestamp

public void setTimestamp(DKTimestamp ts)
                  throws DKException,
                         java.lang.Exception
sets the timestamp
Parameters:
the - time stamp of the work packet

getPriority

public int getPriority()
                throws DKException,
                       java.lang.Exception
gets the priority
Returns:
priority of the work packet

setPriority

public void setPriority(int priority)
                 throws DKException,
                        java.lang.Exception
sets the priority
Parameters:
the - priority of the work packet

getWFTemplateName

public java.lang.String getWFTemplateName()
                                   throws DKException,
                                          java.lang.Exception
gets the workflow template name
Returns:
the name of the work flow template associated with this work packet

setWFTemplateName

public void setWFTemplateName(java.lang.String name)
                       throws DKException,
                              java.lang.Exception
sets the workflow template name
Parameters:
name - the name of the work flow template associated with the work packet

addItem

public void addItem(DKPid pid)
             throws DKException,
                    java.lang.Exception
adds new item to this work packet - memory function only

addItem

public void addItem(java.lang.String pidString)
             throws DKException,
                    java.lang.Exception
adds new item to this work packet - memory function only

removeItem

public void removeItem(DKPid pid)
                throws DKException,
                       java.lang.Exception
removes item from this work packet - memory function only

removeItem

public void removeItem(java.lang.String pidString)
                throws DKException,
                       java.lang.Exception
removes item from this work packet - memory function only

getItemIDs

public java.lang.String[] getItemIDs()
                              throws DKException,
                                     java.lang.Exception
returns an array of pidString from this work packet

getItems

public dkCollection getItems()
                      throws DKException,
                             java.lang.Exception
returns a collection DKDDO from this work packet, not yet retrieved contents - shell only

EIP Java APIs

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