Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkWorkFlowAction

All Superinterfaces:
dkCheckableObject
All Known Implementing Classes:
DKWorkFlowActionFed

public interface dkWorkFlowAction
extends dkCheckableObject

This class provides interface methods to access data related to actions in workFlow


Method Summary
 java.lang.String getDescription()
          gets the description of this work flow action
 byte[] getIconData()
          gets icon image represents the action - default is null, no icon
 void getIconDataToFile(java.lang.String fileName)
          gets icon image represents the action - default is null, no icon
 java.lang.String getName()
          gets the name of this work flow action
 java.lang.String getWFUserExitClassName()
          gets the fully qualified class name of the user exit class, must be instance of dkWorkFlowUserExit interface
 java.lang.String getWFUserExitDLL()
          gets the client DLL name
 int getWFUserExitFlag()
          gets the user exit flag: DK_FED_WF_USEREXIT_JAVACLASS or DK_FED_WF_USEREXIT_CLIENTDLL
 java.lang.String getWFUserExitFunction()
          gets the function name
 void setDescription(java.lang.String description)
          sets the description of this work flow action
 void setIconData(byte[] iconData)
          sets the icon image to represent 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 setName(java.lang.String name)
          sets the name for this work flow action
 void setWFUserExitClassName(java.lang.String className)
          sets the fully qualified class name of the user exit class, must be instance of dkWorkFlowUserExit interface
 void setWFUserExitDLL(java.lang.String dllName)
          sets the client DLL name
 void setWFUserExitFlag(int flag)
          sets the user exit flag: DK_FED_WF_USEREXIT_JAVACLASS or DK_FED_WF_USEREXIT_CLIENTDLL
 void setWFUserExitFunction(java.lang.String funcName)
          sets the function name
 
Methods inherited from interface com.ibm.mm.sdk.common.dkCheckableObject
checkin, checkout, getCheckedOutUserid, unlockCheckedOut
 

Method Detail

getName

public java.lang.String getName()
gets the name of this work flow action

setName

public void setName(java.lang.String name)
sets the name for this work flow action

getDescription

public java.lang.String getDescription()
gets the description of this work flow action

setDescription

public void setDescription(java.lang.String description)
sets the description of this work flow action

getIconData

public byte[] getIconData()
gets icon image represents the action - default is null, no icon

setIconData

public void setIconData(byte[] iconData)
sets the icon image to represent the action - default is null, no icon if not set

getIconDataToFile

public void getIconDataToFile(java.lang.String fileName)
                       throws java.lang.Exception
gets icon image represents the action - default is null, no icon

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

getWFUserExitFlag

public int getWFUserExitFlag()
gets the user exit flag: DK_FED_WF_USEREXIT_JAVACLASS or DK_FED_WF_USEREXIT_CLIENTDLL

setWFUserExitFlag

public void setWFUserExitFlag(int flag)
sets the user exit flag: 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, must be instance of dkWorkFlowUserExit interface

setWFUserExitClassName

public void setWFUserExitClassName(java.lang.String className)
sets the fully qualified class name of the user exit class, must be instance of dkWorkFlowUserExit interface

getWFUserExitFunction

public java.lang.String getWFUserExitFunction()
gets the function name

setWFUserExitFunction

public void setWFUserExitFunction(java.lang.String funcName)
sets the function name

getWFUserExitDLL

public java.lang.String getWFUserExitDLL()
gets the client DLL name

setWFUserExitDLL

public void setWFUserExitDLL(java.lang.String dllName)
sets the client DLL name

EIP Java APIs

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