Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkFlowActionFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkFlowActionFed
All Implemented Interfaces:
dkCheckableObject, dkWorkFlowAction, java.io.Serializable

public class DKWorkFlowActionFed
extends java.lang.Object
implements dkWorkFlowAction, java.io.Serializable

See Also:
Serialized Form

Constructor Summary
DKWorkFlowActionFed()
          Default Constructor
DKWorkFlowActionFed(dkDatastore ds)
          Constructor with dkDatastore reference
DKWorkFlowActionFed(dkDatastore ds, java.lang.String name, java.lang.String description)
          Constructor with name and description
 
Method Summary
 void add()
          Deprecated.  
 void checkin()
          Deprecated.  
 void checkout()
          Deprecated.  
 void del()
          Deprecated.  
 java.lang.String getAction()
          Deprecated.  
 java.lang.String getAuditComment()
          Gets the Aduit comment of the work flow action object
 java.lang.String getCheckedOutUserid()
          Deprecated.  
 java.lang.String getCommand()
          Gets the client command of the work flow action object
 dkDatastore getDatastore()
          Gets the datastore
 java.lang.String getDescription()
          Gets the description of this action data
 byte[] getIconData()
          Gets icon Data of the icon that represents the action - default is null, no icon
 void getIconDataToFile(java.lang.String fileName)
          Gets the icon image to represent the action to a file
 java.lang.String getItemId()
          Deprecated.  
 java.lang.String getName()
          Gets the name of this action data
 java.lang.String getPrompt()
          Gets the Prompt of the work flow action object
 java.lang.String getShortcut()
          Gets the shortcut of the work flow action object
 java.lang.String getWFUserExitClassName()
          Gets the fully qualified class name of the user exit class
 java.lang.String getWFUserExitDLL()
          Gets the user exit DLL name of the work flow action object
 int getWFUserExitFlag()
          Deprecated.  
 java.lang.String getWFUserExitFunction()
          Gets the function name of the user exit function
 java.lang.String getWFUserExitURL()
          Gets the exit URL of the work flow action object
 boolean isPredefined()
          Gets "predefined" of this action data
 void retrieve()
          Deprecated.  
 void setAction(java.lang.String auditComment)
          Deprecated.  
 void setAuditComment(java.lang.String auditComment)
          Sets the Audit comment of the work flow action object
 void setCommand(java.lang.String command)
          Sets the client command of the work flow action object
 void setDatastore(dkDatastore ds)
          Sets datastore object
 void setDescription(java.lang.String description)
          Sets the description of this action data
 void setIconData(byte[] iconData)
          Sets the icon data of the icon that represents the action - default is null, no icon if not set
 void setIconDataFromFile(java.lang.String fileName)
          Sets the icon image to represent the action - default is null, no icon if not set
 void setItemId(java.lang.String item_id)
          Deprecated.  
 void setName(java.lang.String name)
          Sets the name for this action data
 void setPredefined(boolean predefined)
          Sets "predefined" of this action data
 void setPrompt(java.lang.String prompt)
          Sets the Prompt of the work flow action object
 void setShortcut(java.lang.String shortcut)
          Sets the shortcut of the work flow action object
 void setWFUserExitClassName(java.lang.String className)
          Sets the fully qualified class name of the user exit class
 void setWFUserExitDLL(java.lang.String dllName)
          Sets the user exit DLL name of the work flow action object
 void setWFUserExitFlag(int flag)
          Deprecated.  
 void setWFUserExitFunction(java.lang.String funcName)
          Sets the function name of the user exit function
 void setWFUserExitURL(java.lang.String url)
          Sets the exit URL of the work flow action object
 void unlockCheckedOut()
          Deprecated.  
 void update()
          Updates this action data in the persistent store
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKWorkFlowActionFed

public DKWorkFlowActionFed()
Default Constructor

DKWorkFlowActionFed

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

DKWorkFlowActionFed

public DKWorkFlowActionFed(dkDatastore ds,
                           java.lang.String name,
                           java.lang.String description)
Constructor with name and description
Parameters:
ds - dkDatastore - datastore object
name - - name of the work flow action object
description - - description of the work flow action object
Method Detail

getItemId

public java.lang.String getItemId()
Deprecated.  

Gets the item id of the work flow action object
Returns:
item id of the work flow action object

setItemId

public void setItemId(java.lang.String item_id)
Deprecated.  

Sets the itemid of the work flow action object
Parameters:
item_id - - item id of the work flow action object

getDatastore

public dkDatastore getDatastore()
Gets the datastore
Returns:
dkDatastore object

setDatastore

public void setDatastore(dkDatastore ds)
Sets datastore object
Parameters:
ds - dkDatastore - datastore object

getName

public java.lang.String getName()
Gets the name of this action data
Specified by:
getName in interface dkWorkFlowAction
Returns:
name of the workf flow action

setName

public void setName(java.lang.String name)
Sets the name for this action data
Specified by:
setName in interface dkWorkFlowAction
Parameters:
name - name of the work flow action object

getDescription

public java.lang.String getDescription()
Gets the description of this action data
Specified by:
getDescription in interface dkWorkFlowAction
Returns:
description of the work flow action object

setDescription

public void setDescription(java.lang.String description)
Sets the description of this action data
Specified by:
setDescription in interface dkWorkFlowAction
Parameters:
description - description of the work flow action object

setPredefined

public void setPredefined(boolean predefined)
Sets "predefined" of this action data
Parameters:
predefined - indicates whether the work flow action is a predefined one or not

isPredefined

public boolean isPredefined()
Gets "predefined" of this action data
Returns:
a boolean valuen indicating whether the work flow action object is a predefined one or not

setIconDataFromFile

public void setIconDataFromFile(java.lang.String fileName)
                         throws java.lang.Exception
Sets the icon image to represent the action - default is null, no icon if not set
Specified by:
setIconDataFromFile in interface dkWorkFlowAction
Parameters:
fileName - the name of the image file
Throws:
java.lang.Exception - if the fileName is not valid

getIconDataToFile

public void getIconDataToFile(java.lang.String fileName)
                       throws java.lang.Exception
Gets the icon image to represent the action to a file
Specified by:
getIconDataToFile in interface dkWorkFlowAction
Parameters:
fileName - the name of the image file
Throws:
DKException - if the fileName is not valid

setIconData

public void setIconData(byte[] iconData)
Sets the icon data of the icon that represents the action - default is null, no icon if not set
Specified by:
setIconData in interface dkWorkFlowAction
Parameters:
iconData - the icon data of the work flow action object

getIconData

public byte[] getIconData()
Gets icon Data of the icon that represents the action - default is null, no icon
Specified by:
getIconData in interface dkWorkFlowAction
Returns:
the icon data of the work flow action object

getWFUserExitFlag

public int getWFUserExitFlag()
Deprecated.  

Gets the user exit flag: DK_FED_WF_USEREXIT_JAVACLASS or DK_FED_WF_USEREXIT_CLIENTDLL
Specified by:
getWFUserExitFlag in interface dkWorkFlowAction
Returns:
a user exit flag of the work flow action object

setWFUserExitFlag

public void setWFUserExitFlag(int flag)
Deprecated.  

Sets the user exit flag
Specified by:
setWFUserExitFlag in interface dkWorkFlowAction
Parameters:
flag - the user exit flag of the work flow action object -- DK_FED_WF_USEREXIT_JAVACLASS or DK_FED_WF_USEREXIT_CLIENTDLL

getWFUserExitClassName

public java.lang.String getWFUserExitClassName()
Gets the fully qualified class name of the user exit class
Specified by:
getWFUserExitClassName in interface dkWorkFlowAction
Returns:
the user exit java class name of the work flow action object

setWFUserExitClassName

public void setWFUserExitClassName(java.lang.String className)
Sets the fully qualified class name of the user exit class
Specified by:
setWFUserExitClassName in interface dkWorkFlowAction
Parameters:
className - the user exit java class name of the work flow action object

getWFUserExitFunction

public java.lang.String getWFUserExitFunction()
Gets the function name of the user exit function
Specified by:
getWFUserExitFunction in interface dkWorkFlowAction
Returns:
the user exit function name of the work flow action object

setWFUserExitFunction

public void setWFUserExitFunction(java.lang.String funcName)
Sets the function name of the user exit function
Specified by:
setWFUserExitFunction in interface dkWorkFlowAction
Parameters:
funcName - a user exit function name of the work flow action object

getWFUserExitDLL

public java.lang.String getWFUserExitDLL()
Gets the user exit DLL name of the work flow action object
Specified by:
getWFUserExitDLL in interface dkWorkFlowAction
Returns:
the user exit DLL name of the work flow action object

setWFUserExitDLL

public void setWFUserExitDLL(java.lang.String dllName)
Sets the user exit DLL name of the work flow action object
Specified by:
setWFUserExitDLL in interface dkWorkFlowAction
Parameters:
dllName - the user exit dll name of the work flow action object

getCommand

public java.lang.String getCommand()
Gets the client command of the work flow action object
Returns:
the user exit command of the work flow action object

setCommand

public void setCommand(java.lang.String command)
Sets the client command of the work flow action object
Parameters:
command - the user exit command of the work flow action object

getWFUserExitURL

public java.lang.String getWFUserExitURL()
Gets the exit URL of the work flow action object
Returns:
the exit URL of the work flow action object

setWFUserExitURL

public void setWFUserExitURL(java.lang.String url)
Sets the exit URL of the work flow action object
Parameters:
url - the user exit flag of the work flow action object

getAuditComment

public java.lang.String getAuditComment()
Gets the Aduit comment of the work flow action object
Returns:
action of the work flow action object

setAuditComment

public void setAuditComment(java.lang.String auditComment)
Sets the Audit comment of the work flow action object
Parameters:
action - the action of the work flow action object

getAction

public java.lang.String getAction()
Deprecated.  

Gets the Aduit comment of the work flow action object
Returns:
action of the work flow action object

setAction

public void setAction(java.lang.String auditComment)
Deprecated.  

Sets the Audit comment of the work flow action object
Parameters:
action - the action of the work flow action object

getPrompt

public java.lang.String getPrompt()
Gets the Prompt of the work flow action object
Returns:
the prompt of the work flow action object

setPrompt

public void setPrompt(java.lang.String prompt)
Sets the Prompt of the work flow action object
Parameters:
prompt - the prompt of the work flow action object

getShortcut

public java.lang.String getShortcut()
Gets the shortcut of the work flow action object
Returns:
the shortcut of the work flow action object

setShortcut

public void setShortcut(java.lang.String shortcut)
Sets the shortcut of the work flow action object
Parameters:
the - shortcut of the work flow action object

add

public void add()
         throws DKAlreadyExistException,
                DKException
Deprecated.  

Adds this work flow action object into the persistent store
Throws:
DKAlreadyExistException - if the work flow action already exists
DKException - when error occurs in the server

del

public void del()
         throws DKNotExistException,
                DKException
Deprecated.  

Deletes this work flow action object from the persistent store
Throws:
DKNotExitException - if the work flow action object does not exists
DKException - when error occurs in the server

update

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

retrieve

public void retrieve()
              throws DKNotExistException,
                     DKException
Deprecated.  

Retrieves this action data from the persistent store
Throws:
DKNotExistException - if the work flow action does not exists
DKException - when error occurs in the server

checkin

public void checkin()
             throws DKNotCheckedOutException,
                    DKException
Deprecated.  

Check in this work flow action object
Specified by:
checkin in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work flow action 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 DKAlreadyCheckedOutException,
                     DKException
Deprecated.  

Check out the work flow action object
Specified by:
checkout in interface dkCheckableObject
Throws:
DKAlreadyCheckedOutException - if the work flow action has already been checked out
DKException - when error occurs in the server

unlockCheckedOut

public void unlockCheckedOut()
                      throws DKNotCheckedOutException,
                             DKException
Deprecated.  

Unlocks this work flow action object, which is currently checked out, from the persisten datastore
Specified by:
unlockCheckedOut in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work flow action is not checked out
DKException - when error occurs in the server

getCheckedOutUserid

public java.lang.String getCheckedOutUserid()
                                     throws DKNotCheckedOutException,
                                            DKException
Deprecated.  

Gets the checked out userid of the work flow action object
Specified by:
getCheckedOutUserid in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work flow action is not checked out
DKException - when error occurs in the server

EIP Java APIs

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