Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkFlowDiagramFed

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

public class DKWorkFlowDiagramFed
extends java.lang.Object
implements dkWorkFlowDiagram, java.io.Serializable

See Also:
Serialized Form

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

DKWorkFlowDiagramFed

public DKWorkFlowDiagramFed()
Default Constructor

DKWorkFlowDiagramFed

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

DKWorkFlowDiagramFed

public DKWorkFlowDiagramFed(dkDatastore ds,
                            java.lang.String name,
                            java.lang.String description)
Construct a new instance of DKWorkFlowDiagramFed with name and description
Parameters:
name - name of the work flow diagram object
description - description of the work flow diagram object
Method Detail

getDatastore

public dkDatastore getDatastore()
Gets the datastore
Returns:
the datastore object associated with this work flow diagram object

setDatastore

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

getName

public java.lang.String getName()
Gets the name of this work flow diagram
Returns:
the name of this work flow diagram object

setName

public void setName(java.lang.String name)
Sets the name for this work flow diagram
Parameters:
name - name of the work flow diagram object

getDescription

public java.lang.String getDescription()
Gets the description of this work flow diagram
Returns:
the description of this work flow diagram

setDescription

public void setDescription(java.lang.String description)
Sets the description of this work flow diagram
Parameters:
description - description of the work flow diagram object

getACLName

public java.lang.String getACLName()
Gets the ACL name of this work flow diagram
Returns:
the ACL name of this work flow diagram

setACLName

public void setACLName(java.lang.String name)
Sets the ACL name of this work flow diagram
Parameters:
name - ACL name of the work flow diagram

getWorkFlowRelease

public java.lang.String getWorkFlowRelease()
Gets the workf flow release of this work flow diagram
Returns:
the work flow release of this work flow diagram

setWorkFlowRelease

public void setWorkFlowRelease(java.lang.String wfRelease)
Sets the work flow release of this work flow diagram
Parameters:
wfRelease - work flow release of the work flow diagram

getWorkFlowMQCodePage

public java.lang.String getWorkFlowMQCodePage()
Gets the workf flow MQ code page of this work flow diagram
Returns:
the work flow MQ code page of this work flow diagram

setWorkFlowMQCodePage

public void setWorkFlowMQCodePage(java.lang.String wfMQCodePage)
Sets the work flow MQ code page of this work flow diagram
Parameters:
wfMQCodePage - work flow MQ code page of the work flow diagram

getWorkFlowMQRelease

public java.lang.String getWorkFlowMQRelease()
Gets the workf flow MQ release of this work flow diagram
Returns:
the work flow MQ release of this work flow diagram

setWorkFlowMQRelease

public void setWorkFlowMQRelease(java.lang.String wfMQRelease)
Sets the work flow release of this work flow diagram
Parameters:
wfRelease - work flow release of the work flow diagram

getWorkFlowActionListName

public 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
Returns:
the work flow action list name of this work flow diagram

setWorkFlowActionListName

public void setWorkFlowActionListName(java.lang.String actionListName)
Sets the work flow action list name of this work flow diagram
Parameters:
actionListName - the work flow action list name of the work flow diagram

getWorkFlowPerformByGroup

public java.lang.String getWorkFlowPerformByGroup()
Gets the name of the group performing this work flow diagram
Returns:
the name of the group performing this work flow diagram

setWorkFlowPerformByGroup

public void setWorkFlowPerformByGroup(java.lang.String groupName)
Sets the name of the group performing this work flow diagram
Parameters:
groupName - name of the group performing this work flow diagram

setWorkFlowPerformByUser

public void setWorkFlowPerformByUser(java.lang.String userName)
Sets the name of the user performing this work flow diagram
Parameters:
userName - name of the group performing this work flow diagram

getWorkFlowPerformByUser

public java.lang.String getWorkFlowPerformByUser()
Gets the name of the user performing this work flow diagram
Returns:
the name of the user performing this work flow diagram

setWorkFlowNotifyEnabled

public void setWorkFlowNotifyEnabled(boolean isNotifyEnabled)
Sets whether this work flow diagram is capable of notification of not

isWorkFlowNotifyEnabled

public boolean isWorkFlowNotifyEnabled()
Returns whether or not this workflow is capable of notification

setWorkFlowNotifyTo

public void setWorkFlowNotifyTo(java.lang.String notifyUserName)
Sets the name of the user to be notified for this work flow diagram
Parameters:
notifyUserName - name of the user to be notified for this work flow diagram

getWorkFlowNotifyTo

public java.lang.String getWorkFlowNotifyTo()
Gets the name of the user to be notified for this work flow diagram
Returns:
the name of the user to be notofied for this work flow diagram

setWorkFlowVariablePrompt

public void setWorkFlowVariablePrompt(short index,
                                      java.lang.String prompt)
Sets the prompt of the workflow variable for this work flow diagram
Parameters:
prompt - the prompt of the workflow variable for this work flow diagram

getWorkFlowVariablePrompt

public java.lang.String getWorkFlowVariablePrompt(short index)
Gets the prompt of the workflow variable for this work flow diagram
Returns:
the prompt of the workflow variable for this work flow diagram

setWorkFlowVariableName

public void setWorkFlowVariableName(short index,
                                    java.lang.String name)
Sets the name of the workflow variable for this work flow diagram
Parameters:
name0 - the name of the workflow variable for this work flow diagram

getWorkFlowVariableName

public java.lang.String getWorkFlowVariableName(short index)
Gets the name of the workflow variable for this work flow diagram
Returns:
the name of the workflow variable for this work flow diagram

setWorkFlowVariableValue

public void setWorkFlowVariableValue(short index,
                                     java.lang.String value)
Sets the value of the workflow variable for this work flow diagram
Parameters:
value0 - the value of the workflow variable for this work flow diagram

getWorkFlowVariableValue

public java.lang.String getWorkFlowVariableValue(short index)
Gets the value of the workflow variable for this work flow diagram
Returns:
the value of the workflow variable for this work flow diagram

setWorkFlowVariablePromptFlag

public void setWorkFlowVariablePromptFlag(short index,
                                          boolean flag)
Sets the prompt flag of the workflow variable for this work flow diagram
Parameters:
flag - the flag of the workflow variable for this work flow diagram

getWorkFlowVariablePromptFlag

public boolean getWorkFlowVariablePromptFlag(short index)
Gets the prompt flag of the workflow variable for this work flow diagram
Returns:
the flag of the workflow variable for this work flow diagram

getPromptCount

public int getPromptCount()
Gets the number of prompts of the work flow diagram
Returns:
the number of prompts for this work flow diagram

getPromptKeys

public java.util.Enumeration getPromptKeys()
Gets the number of prompts of the work flow diagram
Returns:
the number of prompts for this work flow diagram

setWorkFlowShowDialog

public void setWorkFlowShowDialog(boolean isShowDialog)
Sets whether this work flow diagram should show dialog

isWorkFlowShowDialog

public boolean isWorkFlowShowDialog()
Returns whether this work flow diagram should show dialog

setWorkFlowInternalTimeStamp

public void setWorkFlowInternalTimeStamp(DKTimestamp ts)
Sets the value of the work flow internal timestamp for this work flow diagram
Parameters:
ts - the value of the internal timestamp for this work flow diagram

getWorkFlowInternalTimeStamp

public DKTimestamp getWorkFlowInternalTimeStamp()
Gets the value of the workflow internal timestamp for this work flow diagram
Returns:
the value of the internal timestamp for this work flow diagram

setWorkFlowIconSize

public void setWorkFlowIconSize(long size)
Sets the value of the workflow icon size for this work flow diagram
Parameters:
size - the size of the workflow icon for this work flow diagram

getWorkFlowIconSize

public long getWorkFlowIconSize()
Gets the value of the workflow icon size for this work flow diagram
Returns:
the value of the workflow icon size for this work flow diagram

getWorkFlowIconType

public short getWorkFlowIconType()
Gets the value of the workflow icon type for this work flow diagram
Returns:
the value of the workflow icon type for this work flow diagram

setWorkFlowIconType

public void setWorkFlowIconType(short iconType)
Sets the value of the workflow icon type for this work flow diagram
Returns:
the value of the workflow icon type for this work flow diagram

setWorkFlowFont

public void setWorkFlowFont(java.lang.String font)
Sets the value of the workflow font for this work flow diagram
Parameters:
font - the font of this work flow diagram

getWorkFlowFont

public java.lang.String getWorkFlowFont()
Gets the value of the font for this work flow diagram
Returns:
the font for this work flow diagram

setWorkFlowLastUserExitDirectoryShown

public void setWorkFlowLastUserExitDirectoryShown(java.lang.String dir)
Sets the value of the last user exit directory for this work flow diagram
Parameters:
dir - the last user exit directory for this work flow diagram

getWorkFlowLastUserExitDirectoryShown

public java.lang.String getWorkFlowLastUserExitDirectoryShown()
Gets the value of the last user exit directory for this work flow diagram
Returns:
the last user exit directory for this work flow diagram

getData

public java.lang.String getData()
Gets the data of the work flow diagram object
Specified by:
getData in interface dkWorkFlowDiagram
Returns:
the data of this work flow diagram

setData

public void setData(java.lang.String data)
Sets the data of the work flow diagram object
Specified by:
setData in interface dkWorkFlowDiagram
Parameters:
data - the data of this work flow diagram

getDataToFile

public void getDataToFile(java.lang.String fileName)
                   throws java.lang.Exception
Gets work flow diagram data to file
Parameters:
fileName - the name of the file to which the data of this work flow diagram is to be written
Throws:
java.lang.Exception - if the file name is not valid

setDataFromFile

public void setDataFromFile(java.lang.String fileName)
                     throws java.lang.Exception
Sets work flow diagram data from file
Parameters:
fileName - the name of the file from which the data of this work flow diagram is to be read
Throws:
java.lang.Exception - if the file name is not valid

getWorkFlowFDL

public java.lang.String getWorkFlowFDL()
Gets the data of the work flow diagram object
Returns:
the data of this work flow diagram

setWorkFlowFDL

public void setWorkFlowFDL(java.lang.String workflowFDL)
Sets the data of the work flow diagram object
Parameters:
data - the data of this work flow diagram

getWorkFlowFDLToFile

public void getWorkFlowFDLToFile(java.lang.String fileName)
                          throws java.lang.Exception
Gets work flow diagram data to file
Parameters:
fileName - the name of the file to which the data of this work flow diagram is to be written
Throws:
java.lang.Exception - if the file name is not valid

setWorkFlowFDLFromFile

public void setWorkFlowFDLFromFile(java.lang.String fileName)
                            throws java.lang.Exception
Sets work flow diagram data from file
Parameters:
fileName - the name of the file from which the data of this work flow diagram is to be read
Throws:
java.lang.Exception - if the file name is not valid

setNotifyAfter

public void setNotifyAfter(java.lang.String notifyAfter)
Sets the time stamp to notify after for this work flow diagram
Parameters:
notifyAfter - the time stamp in String

getNotifyAfter

public java.lang.String getNotifyAfter()
Gets the time stamp to notify after for this work flow diagram
Returns:
the time stamp to notify after

setDetailACL

public void setDetailACL(java.lang.String detailACL)
Sets the detailed ACL for this work flow diagram
Parameters:
detailACL - the detailed ACL of this work flow diagram

getDetailACL

public java.lang.String getDetailACL()
Gets the detailed ACL for this work flow diagram
Returns:
the detailed ACL of this work flow diagram

add

public void add()
         throws DKAlreadyExistException,
                DKException
Addg this work flow diagram object into the persistent store
Throws:
DKAlreadyExistException - if the work flow diagram already exists
DKException - when error occurs in the server

del

public void del()
         throws DKNotExistException,
                DKNotCheckedOutException,
                DKException
Delete this workFlow diagram from the persistent store
Throws:
DKNotExitException - if the work flow diagram object does not exists
DKException - when error occurs in the server

update

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

retrieve

public void retrieve()
              throws DKNotExistException,
                     DKException
Deprecated.  

Retrieve this workFlow diagram from the persistent store
Throws:
DKNotExistException - if the work flow diagram does not exists
DKException - when error occurs in the server

checkin

public void checkin()
             throws DKNotCheckedOutException,
                    DKException
Check in the work flow diagram object
Specified by:
checkin in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work flow diagram 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 DKNotExistException,
                     DKAlreadyCheckedOutException,
                     DKException
Check out the work flow diagram object
Specified by:
checkout in interface dkCheckableObject
Throws:
DKAlreadyCheckedOutException - if the work flow diagram has already been checked out
DKException - when error occurs in the server

unlockCheckedOut

public void unlockCheckedOut()
                      throws DKNotCheckedOutException,
                             DKException
Unlocks the work flow diagram, which is currently checked out, from the persistent datastore
Specified by:
unlockCheckedOut in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work flow diagram is not checked out
DKException - when error occurs in the server

getCheckedOutUserid

public java.lang.String getCheckedOutUserid()
                                     throws DKNotCheckedOutException,
                                            DKException
Gets the checked out userid of this work flow diagram
Specified by:
getCheckedOutUserid in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work flow diagram 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.