Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkWorkFlowServiceFed

All Superinterfaces:
dkService
All Known Implementing Classes:
DKWorkFlowServiceFed

public interface dkWorkFlowServiceFed
extends dkService

This class defines methods of service with basic methods


Method Summary
 dkDatastore getDatastore()
          Gets the reference to the associated datastore object.
 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.
 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 setDatastore(dkDatastore ds)
          Sets the reference to the associated datastore object.
 
Methods inherited from interface com.ibm.mm.sdk.common.dkService
addExtension, connect, connection, destroy, disconnect, getExtension, isConnected, listExtensionNames, removeExtension, serviceCategory, serviceId, serviceName, serviceType, setServiceName, setUserName, userName
 

Method Detail

getDatastore

public dkDatastore getDatastore()
                         throws java.lang.Exception
Gets the reference to the associated datastore object.
Returns:
the dkDatastore object.

setDatastore

public void setDatastore(dkDatastore ds)
                  throws DKUsageError,
                         java.lang.Exception
Sets the reference to the associated datastore object.
Parameters:
ds - datastore.

listWorkFlows

public dkCollection listWorkFlows()
                           throws DKException,
                                  java.lang.Exception
Returns a collection of DKWorkFlowFed objects in the system. Each DKWorkFlowFed object represents a workflow in EIP.

listWorkFlows

public dkCollection listWorkFlows(java.lang.String filter,
                                  java.lang.String sort_criteria,
                                  int threshold)
                           throws DKException,
                                  java.lang.Exception
Returns a collection of DKWorkFlowFed objects in the system based on the given filter, sort criteria and threshold. Each DKWorkFlowFed object represents a workflow in EIP.
Parameters:
filter - filter criteria for querying
sort_criteria - sort criteria for sorting
threshold - number of returned results (DK_FED_FMC_MAX_RESULTS for max results)
Returns:
a collection of DKWorkFlowFed objects.

listWorkItems

public dkCollection listWorkItems(java.lang.String filter,
                                  java.lang.String sort_criteria,
                                  int threshold)
                           throws DKException,
                                  java.lang.Exception
Returns a collection of DKWorkItemFed objects in the system based on the given filter, sort criteria and threshold. Each DKWorkItemFed object represents a work item in the system.
Parameters:
filter - filter criteria for querying
sort_criteria - sort criteria for sorting
threshold - number of returned results (DK_FED_FMC_MAX_RESULTS for max results)
Returns:
a collection of DKWorkItemFed objects.

listWorkFlowTemplates

public dkCollection listWorkFlowTemplates()
                                   throws DKException,
                                          java.lang.Exception
Returns a collection of DKWorkFlowTemplateFed objects in the system.

listWorkLists

public dkCollection listWorkLists()
                           throws DKException,
                                  java.lang.Exception
Returns a collection of DKWorkListFed objects in the system.

isWorkFlow

public boolean isWorkFlow(java.lang.String name)
                   throws DKException,
                          java.lang.Exception
Checks if the specified name is a workflow.

isWorkFlowTemplate

public boolean isWorkFlowTemplate(java.lang.String name)
                           throws DKException,
                                  java.lang.Exception
Checks if the specified name is a workflow template.

isWorkList

public boolean isWorkList(java.lang.String name)
                   throws DKException,
                          java.lang.Exception
Checks if the specified name is a worklist.

EIP Java APIs

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