|
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.server.dkAbstractService | +--com.ibm.mm.sdk.server.DKWorkFlowServiceFed
This is an implementation of workflow service for EIP that provides a set of methods for the document-based workflow.
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKWorkFlowServiceFed()
Constructs a new DKWorkFlowServiceFed object. |
|
DKWorkFlowServiceFed(java.lang.String configuration)
Constructs a new DKWorkFlowServiceFed object with configuration. |
Method Summary | |
void |
addExtension(java.lang.String extensionName,
dkExtension extensionObj)
Adds a new extension object. |
void |
connect(java.lang.String service_name,
java.lang.String user_name,
java.lang.String authentication,
java.lang.String connect_string)
Connects to the named workflow service with user name, authentication, and connect string information. |
DKHandle |
connection()
Returns the connection handle of the workflow service. |
void |
disconnect()
Disconnects from the workflow service. |
dkDatastore |
getDatastore()
Gets the reference to the associated datastore object. |
dkExtension |
getExtension(java.lang.String extensionName)
Gets the extension object from a given extenstion name. |
boolean |
isConnected()
Returns the status of connecting to the workflow service. |
boolean |
isWorkFlow(java.lang.String name)
Checks if the specified name is a workflow. |
boolean |
isWorkFlowTemplate(java.lang.String name)
Checks if the specified name is a workflow template. |
boolean |
isWorkList(java.lang.String name)
Checks if the specified name is a worklist. |
java.lang.String[] |
listExtensionNames()
Gets the list of extension objects' names |
dkCollection |
listWorkFlows()
Returns a collection of DKWorkFlowFed objects in the system. |
dkCollection |
listWorkFlows(java.lang.String filter,
java.lang.String sort_criteria,
int threshold)
Returns a collection of DKWorkFlowFed objects in the system based on the given filter, sort criteria and threshold. |
dkCollection |
listWorkFlowTemplates()
Returns a collection of DKWorkFlowTemplateFed objects in the system. |
dkCollection |
listWorkItems(java.lang.String filter,
java.lang.String sort_criteria,
int threshold)
Returns a collection of DKWorkItemFed objects in the system based on the given filter, sort criteria and threshold. |
dkCollection |
listWorkLists()
Returns a collection of DKWorkListFed objects in the system. |
void |
removeExtension(java.lang.String extensionName)
Remove an existing extension object |
java.lang.String |
serviceCategory()
Returns the category of the service. |
java.lang.String |
serviceName()
Returns the name of the workflow service. |
java.lang.String |
serviceType()
Returns the type of the workflow service. |
void |
setDatastore(dkDatastore ds)
Sets the reference to the associated datastore object. |
void |
setServiceName(java.lang.String service_name)
Sets the name of the service. |
void |
setUserName(java.lang.String user_name)
Sets the anem of the user. |
java.lang.String |
userName()
Returns the user name. |
Methods inherited from class com.ibm.mm.sdk.server.dkAbstractService |
destroy, serviceId |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.mm.sdk.common.dkService |
destroy, serviceId |
Constructor Detail |
public DKWorkFlowServiceFed() throws DKException, java.lang.Exception
This is the default constructor of DKWorkFlowServiceFed.
public DKWorkFlowServiceFed(java.lang.String configuration) throws DKException, java.lang.Exception
The configuration parameter is optional and reserved for future use.
configuration
- a configuration string.Method Detail |
public void connect(java.lang.String service_name, java.lang.String user_name, java.lang.String authentication, java.lang.String connect_string) throws DKException, java.lang.Exception
Make sure that the same user name is used for both DKDatastoreFed and DKWorkFlowServiceFed. The setDatastore method needs to be called before connecting to the named workflow service.
DKWorkFlowServiceFed svWF = new DKWorkFlowServiceFed (); DKDatastoreFed fedDS = new DKDatastoreFed(); fedDS.connect (wfsrv, userid, pw, ""); svWF.setDatastore (fedDS); svWF.connect (wfsrv, userid, pw, "");
connect
in interface dkService
connect
in class dkAbstractService
service_name
- name of the service.user_name
- user name.authentication
- authentification of the user.connect_string
- optional connection string.DKDatastoreError
- if already connected to a workflow service.DKUsageError
- if user name is incorrenct or DKWorkFlowServieFed is null.DKDatastoreAccessError
- if having a problem connecting to a workflow service.public void disconnect() throws DKException, java.lang.Exception
disconnect
in interface dkService
disconnect
in class dkAbstractService
DKDatastoreAccessError
- if having a problem in disconnecting the workflow service.public java.lang.String serviceName() throws java.lang.Exception
serviceName
in interface dkService
serviceName
in class dkAbstractService
public java.lang.String serviceType() throws java.lang.Exception
serviceType
in interface dkService
serviceType
in class dkAbstractService
public java.lang.String serviceCategory() throws java.lang.Exception
serviceCategory
in interface dkService
serviceCategory
in class dkAbstractService
public java.lang.String userName() throws java.lang.Exception
userName
in interface dkService
userName
in class dkAbstractService
public DKHandle connection() throws java.lang.Exception
connection
in interface dkService
connection
in class dkAbstractService
DKUsageError
- if the DKWorkFlowServiceFed object is not connected.public boolean isConnected() throws java.lang.Exception
isConnected
in interface dkService
isConnected
in class dkAbstractService
public void setServiceName(java.lang.String service_name) throws java.lang.Exception
setServiceName
in interface dkService
setServiceName
in class dkAbstractService
service_name
- name of the service.public void setUserName(java.lang.String user_name) throws java.lang.Exception
setUserName
in interface dkService
setUserName
in class dkAbstractService
user_name
- user name.public dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
Not implemented in this class.
getExtension
in interface dkService
getExtension
in class dkAbstractService
extensionName
- name of the extension object.public void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
Not implemented in this class.
addExtension
in interface dkService
addExtension
in class dkAbstractService
extensionName
- name of new extension objectextensionObj
- the extension object to be setpublic void removeExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
Not implemented in this class.
removeExtension
in interface dkService
removeExtension
in class dkAbstractService
extensionName
- name of extension object to be removedpublic java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
Not implemented in this class.
listExtensionNames
in interface dkService
listExtensionNames
in class dkAbstractService
public dkDatastore getDatastore() throws java.lang.Exception
getDatastore
in interface dkWorkFlowServiceFed
public void setDatastore(dkDatastore ds) throws DKUsageError, java.lang.Exception
setDatastore
in interface dkWorkFlowServiceFed
ds
- datastore.public dkCollection listWorkFlows() throws DKException, java.lang.Exception
The following code assumes svWF is a connected DKWorkFlowServiceFed object.
DKSequentialCollection coll = (DKSequentialCollection)svWF.listWorkFlows();
listWorkFlows
in interface dkWorkFlowServiceFed
DKUsageError
- if the DKWorkFlowServiceFed object is not connected or
the workflows cannot be retrieved.public dkCollection listWorkFlows(java.lang.String filter, java.lang.String sort_criteria, int threshold) throws DKException, java.lang.Exception
The following code assumes svWF is a connected DKWorkFlowServiceFed object. The filter "NAME LIKE '*Claim*'" will query workflow name with a substring 'Claim'. The sort criteria "NAME DESC" will sort workflows by workflow name in the descending order. The threshold DK_FED_FMC_MAX_RESULTS indicates that the query will return all.
DKSequentialCollection coll = (DKSequentialCollection)svWF.listWorkFlows("NAME LIKE '*Claim*'", "NAME DESC", DK_FED_FMC_MAX_RESULTS);
listWorkFlows
in interface dkWorkFlowServiceFed
filter
- filter criteria for queryingsort_criteria
- sort criteria for sortingthreshold
- number of returned results (DK_FED_FMC_MAX_RESULTS for max results)DKUsageError
- if the DKWorkFlowServiceFed object is not connected or
the workflows cannot be retrieved.public dkCollection listWorkItems(java.lang.String filter, java.lang.String sort_criteria, int threshold) throws DKException, java.lang.Exception
The following code assumes svWF is a connected DKWorkFlowServiceFed object. The filter "NAME LIKE '*ST*'" will query for work item name with a substring 'ST'. The sort criteria "NAME DESC" will sort workitems by work item name in the descending order. The threshold DK_FED_FMC_MAX_RESULTS indicates that the query will return all.
DKSequentialCollection coll = (DKSequentialCollection)svWF.listWorkItems("NAME LIKE '*ST*'", "NAME DESC", DK_FED_FMC_MAX_RESULTS);
listWorkItems
in interface dkWorkFlowServiceFed
filter
- filter criteria for queryingsort_criteria
- sort criteria for sortingthreshold
- number of returned results (DK_FED_FMC_MAX_RESULTS for max results)DKUsageError
- if the DKWorkFlowServiceFed object is not connected or
the workitems cannot be retrieved.public dkCollection listWorkFlowTemplates() throws DKException, java.lang.Exception
The following code assumes svWF is a connected DKWorkFlowServiceFed object.
DKSequentialCollection coll = (DKSequentialCollection)svWF.listWorkFlowTemplates();
listWorkFlowTemplates
in interface dkWorkFlowServiceFed
DKUsageError
- if the DKWorkFlowServiceFed object is not connected or
the workflow templates cannot be retrieved.public dkCollection listWorkLists() throws DKException, java.lang.Exception
The following code assumes svWF is a connected DKWorkFlowServiceFed object.
DKSequentialCollection coll = (DKSequentialCollection)svWF.listWorkLists();
listWorkLists
in interface dkWorkFlowServiceFed
DKUsageError
- if the DKWorkFlowServiceFed object is not connected or
the worklists cannot be retrieved.public boolean isWorkFlow(java.lang.String name) throws DKException, java.lang.Exception
The following code assumes svWF is a connected DKWorkFlowServiceFed object.
boolean isWF = svWF.isWorkFlow("WF");
isWorkFlow
in interface dkWorkFlowServiceFed
name
- a workflow nameDKUsageError
- if the DKWorkFlowServiceFed object is not connected.public boolean isWorkFlowTemplate(java.lang.String name) throws DKException, java.lang.Exception
The following code assumes svWF is a connected DKWorkFlowServiceFed object.
boolean isWF = svWF.isWorkFlowTemplate("WT");
isWorkFlowTemplate
in interface dkWorkFlowServiceFed
name
- a workflow template nameDKUsageError
- if the DKWorkFlowServiceFed object is not connected.public boolean isWorkList(java.lang.String name) throws DKException, java.lang.Exception
The following code assumes svWF is a connected DKWorkFlowServiceFed object.
boolean isWL = svWF.isWorkList("WL");
isWorkList
in interface dkWorkFlowServiceFed
name
- a worklist nameDKUsageError
- if the DKWorkFlowServiceFed object is not connected.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |