com.adobe.livecycle.ibmfilenetprocessengineconnector.client
Interface IIBMFileNetProcessEngineConnectorServiceClient


public interface IIBMFileNetProcessEngineConnectorServiceClient

IBM FileNet Proces Engine Connector service client interface:

This interface contains all methods that can be invoked on the IBM FileNet Proces Engine Connector service using the service client

Since:
27 August 2007

Method Summary
 void dispatchWorkflowStep(String userName, String password, String queueName, String workObjectNumber)
          Dispatches the IBM FileNet Workflow Step
 Map retrieveWorkflowStepParameters(String userName, String password, String queueName, String workObjectNumber, List parameterNameList)
          Retrieves the values for parameters associated with a given IBM FileNet Workflow Step
 void setWorkflowStepParameters(String userName, String password, String queueName, String workObjectNumber, Map parameterNameValueMap)
          Sets the values for parameters associated with a given IBM FileNet Workflow Step
 

Method Detail

dispatchWorkflowStep

void dispatchWorkflowStep(String userName,
                          String password,
                          String queueName,
                          String workObjectNumber)
                          throws RepositoryException
Dispatches the IBM FileNet Workflow Step

Parameters:
userName - Required. User name to be used to connect with IBM FileNet Process Engine.
password - Required. Password to be used to connect with IBM FileNet Process Engine.
queueName - Required. Name of the queue where the IBM FileNet Workflow Step is queued.
workObjectNumber - Required. Work Object Number of the IBM FileNet Workflow Step.
Throws:
RepositoryException - If any of the required parameters are NULL.
RepositoryException - If the user credentials are invalid.
RepositoryException - If the work object is locked by another user.
RepositoryException - In all other cases when the IBM FileNet Process Engine throws an error.

retrieveWorkflowStepParameters

Map retrieveWorkflowStepParameters(String userName,
                                   String password,
                                   String queueName,
                                   String workObjectNumber,
                                   List parameterNameList)
                                   throws RepositoryException
Retrieves the values for parameters associated with a given IBM FileNet Workflow Step

Parameters:
userName - Required. User name to be used to connect with IBM FileNet Process Engine
password - Required. Password to be used to connect with IBM FileNet Process Engine
queueName - Required. Name of the queue in which the IBM FileNet Workflow step is stored
workObjectNumber - Required. Work object number of the IBM FileNet Workflow step
parameterNameList - Required. List containing names of the parameters whose values need to retrieved. If any of the parameter names are not associated with this IBM FileNet Workflow step, an exception is thrown.
Returns:
A map containing step parameters and associated values.
Throws:
RepositoryException - If any of the required parameters are NULL.
RepositoryException - If the user credentials are invalid.
RepositoryException - If the work object is locked by another user.
RepositoryException - In all other cases when the IBM FileNet Process Engine throws an error.

setWorkflowStepParameters

void setWorkflowStepParameters(String userName,
                               String password,
                               String queueName,
                               String workObjectNumber,
                               Map parameterNameValueMap)
                               throws RepositoryException
Sets the values for parameters associated with a given IBM FileNet Workflow Step

Parameters:
userName - Required. User name to be used to connect with IBM FileNet Process Engine.
password - Required. Password to be used to connect with IBM FileNet Process Engine.
queueName - Required. Name of the Queue in which the IBM FileNet Workflow step is stored.
workObjectNumber - Required. Work Object Number of the IBM FileNet Workflow step.
parameterNameValueMap - Required. Map containing step parameter names and associated values whose values need to set. If any of the parameter names are not associated with this IBM FileNet Workflow step, an exception is thrown.
Throws:
RepositoryException - If any of the required parameters are NULL.
RepositoryException - If the user credentials are invalid.
RepositoryException - If the work object is locked by another user.
RepositoryException - In all other cases when IBM FileNet Process Engine throws an error.