com.adobe.idp.taskmanager.dsc.client.endpoint
Interface TaskManagerEndpointClient

All Superinterfaces:

java.io.Serializable

public interface TaskManagerEndpointClient
extends java.io.Serializable

Retrieves and invokes endpoints.

Method Summary

TaskEndpointCategory[]	getCategories() Retrieves a category listing.
TaskEndpoint	getEndpointByName(java.lang.String serviceName, java.lang.String endpointName) Retrieves the specific endpoint requested by name.
TaskEndpoint[]	getEndpointsForCategory(java.lang.String categoryId) Retrieves the endpoints in a category.
TaskEndpoint[]	getEndpointsFromIds(long[] enpointIds) Retrieves the endpoints requested in the list of identifiers.
EndpointInvokeResult	invokeEndpoint(long endpointId) Invokes an endpoint and returns the endpoint result.
EndpointInvokeResult	invokeEndpointFromStartTask(long taskId) Invokes the same endpoint a previously completed task was invoked from, using that task's data as default data for the newly created task, and returns the endpoint result.

Method Detail

getCategories

TaskEndpointCategory[] getCategories()
                                     throws TaskEndpointException

Retrieves a category listing. Only categories with configured TaskManager Connector endpoints are returned.

Returns:

The category listing, which is stored in an array of TaskEndpointCategory objects.

Throws:

TaskEndpointException

getEndpointsForCategory

TaskEndpoint[] getEndpointsForCategory(java.lang.String categoryId)
                                       throws TaskEndpointException

Retrieves the endpoints in a category. Only endpoints for which the user has permission to invoke are returned.

Parameters:

categoryId - The category identifier for which to return endpoints.

Returns:

The category endpoints, which are stored in an array of TaskEndpoint objects.

Throws:

TaskEndpointException

invokeEndpoint

EndpointInvokeResult invokeEndpoint(long endpointId)
                                    throws TaskEndpointNotFound,
                                           TaskEndpointException

Invokes an endpoint and returns the endpoint result. Invoking an endpoint will perform the functionality defined by the TaskManager Connector, which creates an initial task for the process using the input form variable to define the form for that task. The task is constructed in such a way as to invoke the service when it is completed. Generally the service being invoked is a long-lived workflow.

Parameters:

endpointId - The endpoint to invoke.

Returns:

The endpoint result, stored in an EndpointInvokeResult object.

Throws:

TaskEndpointException - if there is no input form variable parameter in the service to call or if the user does not have access to invoke the service.

TaskEndpointNotFound - if the endpoint could not be found.

invokeEndpointFromStartTask

EndpointInvokeResult invokeEndpointFromStartTask(long taskId)
                                                 throws TaskEndpointNotFound,
                                                        TaskEndpointException

Invokes the same endpoint a previously completed task was invoked from, using that task's data as default data for the newly created task, and returns the endpoint result. Invoking an endpoint will perform the functionality defined by the TaskManager Connector, which creates an initial task for the process using the input form variable to define the form for that task. The task is constructed in such a way as to invoke the service when it is completed. Generally the service being invoked is a long-lived workflow.

Parameters:

taskId - The taskId used to invoke the endpoint

Returns:

The endpoint result, stored in an EndpointInvokeResult object.

Throws:

TaskEndpointException - if there is no input form variable parameter in the service to call or if the user does not have access to invoke the service.

TaskEndpointNotFound - if a suitable endpoint could not be found.

getEndpointsFromIds

TaskEndpoint[] getEndpointsFromIds(long[] enpointIds)
                                   throws TaskEndpointException

Retrieves the endpoints requested in the list of identifiers.

Parameters:

enpointIds - An array of endpoint identifiers.

Returns:

The endpoints requested in the array of endpoint identifiers.

Throws:

TaskEndpointException

getEndpointByName

TaskEndpoint getEndpointByName(java.lang.String serviceName,
                               java.lang.String endpointName)
                               throws TaskEndpointException

Retrieves the specific endpoint requested by name.

Parameters:

serviceName - The name of the service for the endpoint.

endpointName - The name of the endpoint.

Returns:

The specific endpoint requested.

Throws:

TaskEndpointException