|
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.DKWorkFlowActionFed
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 |
public DKWorkFlowActionFed()
public DKWorkFlowActionFed(dkDatastore ds)
ds
- dkDatastore - datastore objectpublic DKWorkFlowActionFed(dkDatastore ds, java.lang.String name, java.lang.String description)
ds
- dkDatastore - datastore objectname
- - name of the work flow action objectdescription
- - description of the work flow action objectMethod Detail |
public java.lang.String getItemId()
public void setItemId(java.lang.String item_id)
item_id
- - item id of the work flow action objectpublic dkDatastore getDatastore()
public void setDatastore(dkDatastore ds)
ds
- dkDatastore - datastore objectpublic java.lang.String getName()
getName
in interface dkWorkFlowAction
public void setName(java.lang.String name)
setName
in interface dkWorkFlowAction
name
- name of the work flow action objectpublic java.lang.String getDescription()
getDescription
in interface dkWorkFlowAction
public void setDescription(java.lang.String description)
setDescription
in interface dkWorkFlowAction
description
- description of the work flow action objectpublic void setPredefined(boolean predefined)
predefined
- indicates whether the work flow action is a predefined one or notpublic boolean isPredefined()
public void setIconDataFromFile(java.lang.String fileName) throws java.lang.Exception
setIconDataFromFile
in interface dkWorkFlowAction
fileName
- the name of the image filejava.lang.Exception
- if the fileName is not validpublic void getIconDataToFile(java.lang.String fileName) throws java.lang.Exception
getIconDataToFile
in interface dkWorkFlowAction
fileName
- the name of the image fileDKException
- if the fileName is not validpublic void setIconData(byte[] iconData)
setIconData
in interface dkWorkFlowAction
iconData
- the icon data of the work flow action objectpublic byte[] getIconData()
getIconData
in interface dkWorkFlowAction
public int getWFUserExitFlag()
getWFUserExitFlag
in interface dkWorkFlowAction
public void setWFUserExitFlag(int flag)
setWFUserExitFlag
in interface dkWorkFlowAction
flag
- the user exit flag of the work flow action object -- DK_FED_WF_USEREXIT_JAVACLASS or DK_FED_WF_USEREXIT_CLIENTDLLpublic java.lang.String getWFUserExitClassName()
getWFUserExitClassName
in interface dkWorkFlowAction
public void setWFUserExitClassName(java.lang.String className)
setWFUserExitClassName
in interface dkWorkFlowAction
className
- the user exit java class name of the work flow action objectpublic java.lang.String getWFUserExitFunction()
getWFUserExitFunction
in interface dkWorkFlowAction
public void setWFUserExitFunction(java.lang.String funcName)
setWFUserExitFunction
in interface dkWorkFlowAction
funcName
- a user exit function name of the work flow action objectpublic java.lang.String getWFUserExitDLL()
getWFUserExitDLL
in interface dkWorkFlowAction
public void setWFUserExitDLL(java.lang.String dllName)
setWFUserExitDLL
in interface dkWorkFlowAction
dllName
- the user exit dll name of the work flow action objectpublic java.lang.String getCommand()
public void setCommand(java.lang.String command)
command
- the user exit command of the work flow action objectpublic java.lang.String getWFUserExitURL()
public void setWFUserExitURL(java.lang.String url)
url
- the user exit flag of the work flow action objectpublic java.lang.String getAuditComment()
public void setAuditComment(java.lang.String auditComment)
action
- the action of the work flow action objectpublic java.lang.String getAction()
public void setAction(java.lang.String auditComment)
action
- the action of the work flow action objectpublic java.lang.String getPrompt()
public void setPrompt(java.lang.String prompt)
prompt
- the prompt of the work flow action objectpublic java.lang.String getShortcut()
public void setShortcut(java.lang.String shortcut)
the
- shortcut of the work flow action objectpublic void add() throws DKAlreadyExistException, DKException
DKAlreadyExistException
- if the work flow action already existsDKException
- when error occurs in the serverpublic void del() throws DKNotExistException, DKException
DKNotExitException
- if the work flow action object does not existsDKException
- when error occurs in the serverpublic void update() throws DKNotExistException, DKException
DKNotExistException
- if the work flow action object does not existsDKException
- when error occurs in the serverpublic void retrieve() throws DKNotExistException, DKException
DKNotExistException
- if the work flow action does not existsDKException
- when error occurs in the serverpublic void checkin() throws DKNotCheckedOutException, DKException
checkin
in interface dkCheckableObject
DKNotCheckedOutException
- if the work flow action 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 DKAlreadyCheckedOutException, DKException
checkout
in interface dkCheckableObject
DKAlreadyCheckedOutException
- if the work flow action has already been checked outDKException
- when error occurs in the serverpublic void unlockCheckedOut() throws DKNotCheckedOutException, DKException
unlockCheckedOut
in interface dkCheckableObject
DKNotCheckedOutException
- if the work flow action 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 flow action is not checked outDKException
- when error occurs in the server
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |