|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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 |
---|
void dispatchWorkflowStep(String userName, String password, String queueName, String workObjectNumber) throws RepositoryException
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.
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.Map retrieveWorkflowStepParameters(String userName, String password, String queueName, String workObjectNumber, List parameterNameList) throws RepositoryException
userName
- Required. User name to be used to connect with IBM FileNet Process Enginepassword
- Required. Password to be used to connect with IBM FileNet Process EnginequeueName
- Required. Name of the queue in which the IBM FileNet Workflow step is storedworkObjectNumber
- Required. Work object number of the IBM FileNet Workflow stepparameterNameList
- 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.
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.void setWorkflowStepParameters(String userName, String password, String queueName, String workObjectNumber, Map parameterNameValueMap) throws RepositoryException
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.
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |