com.adobe.livecycle.ibmfilenetprocessengineconnector.client
Class IBMFileNetProcessEngineConnectorServiceClient

java.lang.Object
  com.adobe.livecycle.ibmfilenetprocessengineconnector.client.IBMFileNetProcessEngineConnectorServiceClient

All Implemented Interfaces:

IIBMFileNetProcessEngineConnectorServiceClient

public class IBMFileNetProcessEngineConnectorServiceClient
extends java.lang.Object
implements IIBMFileNetProcessEngineConnectorServiceClient

The IBMFileNetProcessEngineConnectorServiceClient class enables you to create a Java object that can invoke operations supported by the IBM FileNet Content Repository Connector service.

Since:

29 August 2007

Constructor Summary

IBMFileNetProcessEngineConnectorServiceClient(ServiceClientFactory serviceFactory)
Create a IBMFileNetProcessEngineConnectorServiceClient using the given service factory

IBMFileNetProcessEngineConnectorServiceClient(ServiceClientFactory serviceFactory, java.lang.String serviceName)
Create a IBMFileNetContentRepositoryConnectorServiceClient using the given service factory and specified service name

Method Summary

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IBMFileNetProcessEngineConnectorServiceClient

public IBMFileNetProcessEngineConnectorServiceClient(ServiceClientFactory serviceFactory)

Create a IBMFileNetProcessEngineConnectorServiceClient using the given service factory

Parameters:

serviceFactory - A ServiceClientFactory that contains connection properties. For information about connection properties, see Invoking LiveCycle Services.

IBMFileNetProcessEngineConnectorServiceClient

public IBMFileNetProcessEngineConnectorServiceClient(ServiceClientFactory serviceFactory,
                                                     java.lang.String serviceName)

Create a IBMFileNetContentRepositoryConnectorServiceClient using the given service factory and specified service name

Parameters:

serviceFactory - A ServiceClientFactory that contains connection properties.

serviceName - The name of the IBM FileNet Content Repository Connector service.

Method Detail

dispatchWorkflowStep

public void dispatchWorkflowStep(java.lang.String userName,
                                 java.lang.String password,
                                 java.lang.String queueName,
                                 java.lang.String workObjectNumber)
                          throws RepositoryException

Description copied from interface: IIBMFileNetProcessEngineConnectorServiceClient

Dispatches the IBM FileNet Workflow Step

Specified by:

dispatchWorkflowStep in interface IIBMFileNetProcessEngineConnectorServiceClient

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.

See Also:

dispatchWorkflowStep(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

retrieveWorkflowStepParameters

public java.util.Map retrieveWorkflowStepParameters(java.lang.String userName,
                                                    java.lang.String password,
                                                    java.lang.String queueName,
                                                    java.lang.String workObjectNumber,
                                                    java.util.List parameterNameList)
                                             throws RepositoryException

Description copied from interface: IIBMFileNetProcessEngineConnectorServiceClient

Retrieves the values for parameters associated with a given IBM FileNet Workflow Step

Specified by:

retrieveWorkflowStepParameters in interface IIBMFileNetProcessEngineConnectorServiceClient

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.

See Also:

retrieveWorkflowStepParameters(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.List)

setWorkflowStepParameters

public void setWorkflowStepParameters(java.lang.String userName,
                                      java.lang.String password,
                                      java.lang.String queueName,
                                      java.lang.String workObjectNumber,
                                      java.util.Map parameterNameValueMap)
                               throws RepositoryException

Description copied from interface: IIBMFileNetProcessEngineConnectorServiceClient

Sets the values for parameters associated with a given IBM FileNet Workflow Step

Specified by:

setWorkflowStepParameters in interface IIBMFileNetProcessEngineConnectorServiceClient

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.

See Also:

setWorkflowStepParameters(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)