|
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.DKWorkFlowDiagramFed
Constructor Summary | |
DKWorkFlowDiagramFed()
Default Constructor |
|
DKWorkFlowDiagramFed(dkDatastore ds)
Constructor with datastore reference |
|
DKWorkFlowDiagramFed(dkDatastore ds,
java.lang.String name,
java.lang.String description)
Construct a new instance of DKWorkFlowDiagramFed with name and description |
Method Summary | |
void |
add()
Addg this work flow diagram object into the persistent store |
void |
checkin()
Check in the work flow diagram object |
void |
checkout()
Check out the work flow diagram object |
void |
del()
Delete this workFlow diagram from the persistent store |
java.lang.String |
getACLName()
Gets the ACL name of this work flow diagram |
java.lang.String |
getCheckedOutUserid()
Gets the checked out userid of this work flow diagram |
java.lang.String |
getData()
Gets the data of the work flow diagram object |
dkDatastore |
getDatastore()
Gets the datastore |
void |
getDataToFile(java.lang.String fileName)
Gets work flow diagram data to file |
java.lang.String |
getDescription()
Gets the description of this work flow diagram |
java.lang.String |
getDetailACL()
Gets the detailed ACL for this work flow diagram |
java.lang.String |
getName()
Gets the name of this work flow diagram |
java.lang.String |
getNotifyAfter()
Gets the time stamp to notify after for this work flow diagram |
int |
getPromptCount()
Gets the number of prompts of the work flow diagram |
java.util.Enumeration |
getPromptKeys()
Gets the number of prompts of the work flow diagram |
java.lang.String |
getWorkFlowActionListName()
Gets the work flow action list name of this work flow diagram This is default action list name for all the nodes defined in this diagram |
java.lang.String |
getWorkFlowFDL()
Gets the data of the work flow diagram object |
void |
getWorkFlowFDLToFile(java.lang.String fileName)
Gets work flow diagram data to file |
java.lang.String |
getWorkFlowFont()
Gets the value of the font for this work flow diagram |
long |
getWorkFlowIconSize()
Gets the value of the workflow icon size for this work flow diagram |
short |
getWorkFlowIconType()
Gets the value of the workflow icon type for this work flow diagram |
DKTimestamp |
getWorkFlowInternalTimeStamp()
Gets the value of the workflow internal timestamp for this work flow diagram |
java.lang.String |
getWorkFlowLastUserExitDirectoryShown()
Gets the value of the last user exit directory for this work flow diagram |
java.lang.String |
getWorkFlowMQCodePage()
Gets the workf flow MQ code page of this work flow diagram |
java.lang.String |
getWorkFlowMQRelease()
Gets the workf flow MQ release of this work flow diagram |
java.lang.String |
getWorkFlowNotifyTo()
Gets the name of the user to be notified for this work flow diagram |
java.lang.String |
getWorkFlowPerformByGroup()
Gets the name of the group performing this work flow diagram |
java.lang.String |
getWorkFlowPerformByUser()
Gets the name of the user performing this work flow diagram |
java.lang.String |
getWorkFlowRelease()
Gets the workf flow release of this work flow diagram |
java.lang.String |
getWorkFlowVariableName(short index)
Gets the name of the workflow variable for this work flow diagram |
java.lang.String |
getWorkFlowVariablePrompt(short index)
Gets the prompt of the workflow variable for this work flow diagram |
boolean |
getWorkFlowVariablePromptFlag(short index)
Gets the prompt flag of the workflow variable for this work flow diagram |
java.lang.String |
getWorkFlowVariableValue(short index)
Gets the value of the workflow variable for this work flow diagram |
boolean |
isWorkFlowNotifyEnabled()
Returns whether or not this workflow is capable of notification |
boolean |
isWorkFlowShowDialog()
Returns whether this work flow diagram should show dialog |
void |
retrieve()
Deprecated. |
void |
setACLName(java.lang.String name)
Sets the ACL name of this work flow diagram |
void |
setData(java.lang.String data)
Sets the data of the work flow diagram object |
void |
setDataFromFile(java.lang.String fileName)
Sets work flow diagram data from file |
void |
setDatastore(dkDatastore ds)
Sets datastore object |
void |
setDescription(java.lang.String description)
Sets the description of this work flow diagram |
void |
setDetailACL(java.lang.String detailACL)
Sets the detailed ACL for this work flow diagram |
void |
setName(java.lang.String name)
Sets the name for this work flow diagram |
void |
setNotifyAfter(java.lang.String notifyAfter)
Sets the time stamp to notify after for this work flow diagram |
void |
setWorkFlowActionListName(java.lang.String actionListName)
Sets the work flow action list name of this work flow diagram |
void |
setWorkFlowFDL(java.lang.String workflowFDL)
Sets the data of the work flow diagram object |
void |
setWorkFlowFDLFromFile(java.lang.String fileName)
Sets work flow diagram data from file |
void |
setWorkFlowFont(java.lang.String font)
Sets the value of the workflow font for this work flow diagram |
void |
setWorkFlowIconSize(long size)
Sets the value of the workflow icon size for this work flow diagram |
void |
setWorkFlowIconType(short iconType)
Sets the value of the workflow icon type for this work flow diagram |
void |
setWorkFlowInternalTimeStamp(DKTimestamp ts)
Sets the value of the work flow internal timestamp for this work flow diagram |
void |
setWorkFlowLastUserExitDirectoryShown(java.lang.String dir)
Sets the value of the last user exit directory for this work flow diagram |
void |
setWorkFlowMQCodePage(java.lang.String wfMQCodePage)
Sets the work flow MQ code page of this work flow diagram |
void |
setWorkFlowMQRelease(java.lang.String wfMQRelease)
Sets the work flow release of this work flow diagram |
void |
setWorkFlowNotifyEnabled(boolean isNotifyEnabled)
Sets whether this work flow diagram is capable of notification of not |
void |
setWorkFlowNotifyTo(java.lang.String notifyUserName)
Sets the name of the user to be notified for this work flow diagram |
void |
setWorkFlowPerformByGroup(java.lang.String groupName)
Sets the name of the group performing this work flow diagram |
void |
setWorkFlowPerformByUser(java.lang.String userName)
Sets the name of the user performing this work flow diagram |
void |
setWorkFlowRelease(java.lang.String wfRelease)
Sets the work flow release of this work flow diagram |
void |
setWorkFlowShowDialog(boolean isShowDialog)
Sets whether this work flow diagram should show dialog |
void |
setWorkFlowVariableName(short index,
java.lang.String name)
Sets the name of the workflow variable for this work flow diagram |
void |
setWorkFlowVariablePrompt(short index,
java.lang.String prompt)
Sets the prompt of the workflow variable for this work flow diagram |
void |
setWorkFlowVariablePromptFlag(short index,
boolean flag)
Sets the prompt flag of the workflow variable for this work flow diagram |
void |
setWorkFlowVariableValue(short index,
java.lang.String value)
Sets the value of the workflow variable for this work flow diagram |
void |
unlockCheckedOut()
Unlocks the work flow diagram, which is currently checked out, from the persistent datastore |
void |
update()
Update this workFlow diagram in the persistent store |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKWorkFlowDiagramFed()
public DKWorkFlowDiagramFed(dkDatastore ds)
ds
- dkDatastore objectpublic DKWorkFlowDiagramFed(dkDatastore ds, java.lang.String name, java.lang.String description)
name
- name of the work flow diagram objectdescription
- description of the work flow diagram objectMethod Detail |
public dkDatastore getDatastore()
public void setDatastore(dkDatastore ds)
ds
- dkDatastore objectpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- name of the work flow diagram objectpublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- description of the work flow diagram objectpublic java.lang.String getACLName()
public void setACLName(java.lang.String name)
name
- ACL name of the work flow diagrampublic java.lang.String getWorkFlowRelease()
public void setWorkFlowRelease(java.lang.String wfRelease)
wfRelease
- work flow release of the work flow diagrampublic java.lang.String getWorkFlowMQCodePage()
public void setWorkFlowMQCodePage(java.lang.String wfMQCodePage)
wfMQCodePage
- work flow MQ code page of the work flow diagrampublic java.lang.String getWorkFlowMQRelease()
public void setWorkFlowMQRelease(java.lang.String wfMQRelease)
wfRelease
- work flow release of the work flow diagrampublic java.lang.String getWorkFlowActionListName()
public void setWorkFlowActionListName(java.lang.String actionListName)
actionListName
- the work flow action list name of the work flow diagrampublic java.lang.String getWorkFlowPerformByGroup()
public void setWorkFlowPerformByGroup(java.lang.String groupName)
groupName
- name of the group performing this work flow diagrampublic void setWorkFlowPerformByUser(java.lang.String userName)
userName
- name of the group performing this work flow diagrampublic java.lang.String getWorkFlowPerformByUser()
public void setWorkFlowNotifyEnabled(boolean isNotifyEnabled)
public boolean isWorkFlowNotifyEnabled()
public void setWorkFlowNotifyTo(java.lang.String notifyUserName)
notifyUserName
- name of the user to be notified for this work flow diagrampublic java.lang.String getWorkFlowNotifyTo()
public void setWorkFlowVariablePrompt(short index, java.lang.String prompt)
prompt
- the prompt of the workflow variable for this work flow diagrampublic java.lang.String getWorkFlowVariablePrompt(short index)
public void setWorkFlowVariableName(short index, java.lang.String name)
name0
- the name of the workflow variable for this work flow diagrampublic java.lang.String getWorkFlowVariableName(short index)
public void setWorkFlowVariableValue(short index, java.lang.String value)
value0
- the value of the workflow variable for this work flow diagrampublic java.lang.String getWorkFlowVariableValue(short index)
public void setWorkFlowVariablePromptFlag(short index, boolean flag)
flag
- the flag of the workflow variable for this work flow diagrampublic boolean getWorkFlowVariablePromptFlag(short index)
public int getPromptCount()
public java.util.Enumeration getPromptKeys()
public void setWorkFlowShowDialog(boolean isShowDialog)
public boolean isWorkFlowShowDialog()
public void setWorkFlowInternalTimeStamp(DKTimestamp ts)
ts
- the value of the internal timestamp for this work flow diagrampublic DKTimestamp getWorkFlowInternalTimeStamp()
public void setWorkFlowIconSize(long size)
size
- the size of the workflow icon for this work flow diagrampublic long getWorkFlowIconSize()
public short getWorkFlowIconType()
public void setWorkFlowIconType(short iconType)
public void setWorkFlowFont(java.lang.String font)
font
- the font of this work flow diagrampublic java.lang.String getWorkFlowFont()
public void setWorkFlowLastUserExitDirectoryShown(java.lang.String dir)
dir
- the last user exit directory for this work flow diagrampublic java.lang.String getWorkFlowLastUserExitDirectoryShown()
public java.lang.String getData()
getData
in interface dkWorkFlowDiagram
public void setData(java.lang.String data)
setData
in interface dkWorkFlowDiagram
data
- the data of this work flow diagrampublic void getDataToFile(java.lang.String fileName) throws java.lang.Exception
fileName
- the name of the file to which the data of this work flow diagram is to be writtenjava.lang.Exception
- if the file name is not validpublic void setDataFromFile(java.lang.String fileName) throws java.lang.Exception
fileName
- the name of the file from which the data of this work flow diagram is to be readjava.lang.Exception
- if the file name is not validpublic java.lang.String getWorkFlowFDL()
public void setWorkFlowFDL(java.lang.String workflowFDL)
data
- the data of this work flow diagrampublic void getWorkFlowFDLToFile(java.lang.String fileName) throws java.lang.Exception
fileName
- the name of the file to which the data of this work flow diagram is to be writtenjava.lang.Exception
- if the file name is not validpublic void setWorkFlowFDLFromFile(java.lang.String fileName) throws java.lang.Exception
fileName
- the name of the file from which the data of this work flow diagram is to be readjava.lang.Exception
- if the file name is not validpublic void setNotifyAfter(java.lang.String notifyAfter)
notifyAfter
- the time stamp in Stringpublic java.lang.String getNotifyAfter()
public void setDetailACL(java.lang.String detailACL)
detailACL
- the detailed ACL of this work flow diagrampublic java.lang.String getDetailACL()
public void add() throws DKAlreadyExistException, DKException
DKAlreadyExistException
- if the work flow diagram already existsDKException
- when error occurs in the serverpublic void del() throws DKNotExistException, DKNotCheckedOutException, DKException
DKNotExitException
- if the work flow diagram object does not existsDKException
- when error occurs in the serverpublic void update() throws DKNotExistException, DKNotCheckedOutException, DKException
DKNotExistException
- if the work flow diagram object does not existsDKException
- when error occurs in the serverpublic void retrieve() throws DKNotExistException, DKException
DKNotExistException
- if the work flow diagram does not existsDKException
- when error occurs in the serverpublic void checkin() throws DKNotCheckedOutException, DKException
checkin
in interface dkCheckableObject
DKNotCheckedOutException
- if the work flow diagram 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 DKNotExistException, DKAlreadyCheckedOutException, DKException
checkout
in interface dkCheckableObject
DKAlreadyCheckedOutException
- if the work flow diagram 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 diagram 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 diagram 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 |