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

All Superinterfaces:

Serializable

public interface TaskEndpoint
extends Serializable

Provides information about task endpoints, such as service names, operation names, and endpoint IDs. A TaskEndpoint object is returned by searches for category endpoints using TaskManagerEndpointClient.

Method Summary

TaskEndpointCategory	getCategory() Retrieves the category for this endpoint.
String	getDescription() Retrieves the description for this endpoint.
long	getEndpointId() Retrieves the endpoint identifier.
ImageTicket	getImageTicket() Retrieves the image ticket for the current task's process.
String	getName() Retrieves the name of this endpoint for display in the user interface.
String	getOperationName() Retrieves the operation name for this endpoint.
String	getOwner() Retrieves the owner of this endpoint.
String	getServiceName() Retrieves the service name for the endpoint.

Method Detail

getCategory

TaskEndpointCategory getCategory()

Retrieves the category for this endpoint.

Returns:

The category in which this endpoint is categorized.

getEndpointId

long getEndpointId()

Retrieves the endpoint identifier. This key is required in order to use the task manager to invoke the service operation referenced in the endpoint.

Returns:

The endpoint identifier.

getName

String getName()

Retrieves the name of this endpoint for display in the user interface.

Returns:

The name of this endpoint.

getDescription

String getDescription()

Retrieves the description for this endpoint.

Returns:

The description for this endpoint.

getOwner

String getOwner()

Retrieves the owner of this endpoint. Endpoint owners are arbitrary strings, but would generally be the name of a person responsible for this endpoint or process in an organization.

Returns:

The owner of this endpoint.

getServiceName

String getServiceName()

Retrieves the service name for the endpoint.

Returns:

The service name for the endpoint.

getOperationName

String getOperationName()

Retrieves the operation name for this endpoint.

Returns:

The operation name for this endpoint.

getImageTicket

ImageTicket getImageTicket()

Retrieves the image ticket for the current task's process.

Returns:

The image ticket.