com.adobe.idp.dsc.registry.infomodel
Interface Operation

public interface Operation

An Operation object contains metadata describing a service operation.

Field Summary

static short	ACCESS_LEVEL_PRIVATE Represents private access.
static short	ACCESS_LEVEL_PUBLIC Represents public access.
static java.lang.String	TX_PROPAGATION_MANDATORY Represents a mandatory propagation value.
static java.lang.String	TX_PROPAGATION_NEVER Represents a never propagation value.
static java.lang.String	TX_PROPAGATION_NOT_SUPPORTED Represents an unsupported propagation value.
static java.lang.String	TX_PROPAGATION_REQUIRED Represents a required propagation value.
static java.lang.String	TX_PROPAGATION_REQUIRES_NEW Requires a new propagation value.
static java.lang.String	TX_PROPAGATION_SUPPORTS Represents a support propagation value.
static java.lang.String	TX_TYPE_CONTAINER Represents a container type.
static java.lang.String	TX_TYPE_NONE Represents no type.
static java.lang.String	TX_TYPE_SERVICE Represents a service type.

Method Summary

short	getAccessLevel() Retrieves the access level of the operation.
java.util.Map	getAttributes() Retrieves a map of operation attributes.
boolean	getDeprecated() Retrieves whether or not this operation is deprecated.
java.lang.String	getDeprecatedSince() Retrieves when this operation was deprecated.
java.lang.String	getDescription() Retrieves the description of the operation.
Fault[]	getFaults() Retrieves an array of faults that make up the signature of this operation.
java.lang.String	getHint() Retrieves text that describes the purpose of the service to which this operation belongs.
InputParameter	getInputParameter(java.lang.String aName) Retrieves the specified input parameter.
InputParameter[]	getInputParameters() Retrieves all input parameters that are expected by this operation.
byte[]	getLargeIcon() Retrieves the large icon representation of the operation.
Layout	getLayout() Retrieves the layout defined for this operation, which is used to determine how the operation's parameters appear during process design.
boolean	getLongLived() Determines whether the operation is a long-lived operation.
java.lang.String	getName() Retrieves the name of the operation, which must be unique to the service.
OutputParameter	getOutputParameter(java.lang.String aName) Retrieves the specified output parameter.
OutputParameter[]	getOutputParameters() Returns all output parameters that are expected by this operation.
java.lang.String	getReplacedBy() Retrieves what this operation is replaced by.
ServiceConfiguration	getServiceConfiguration() Retrieves the service configuration to which this operation belongs.
java.lang.String	getServiceId() Retrieves the service identifier to which this operation belongs.
byte[]	getSmallIcon() Retrieves the small icon for this operation.
java.lang.String	getSunsettingOn() Retrieves information about when this operation is expected to be removed.
java.lang.String[]	getSupportedConnectorIds() Retrieves an array of connector identifiers, specifying which connectors can be used to set up endpoints for the service to which this operation belongs.
java.lang.String	getTitle() Retrieves the title of the service to which this operation belongs.
java.lang.String	getTransactionPropagation() Retrieves the transaction propagation value.
int	getTransactionTimeout() Retrieves the number of seconds the container should wait for this operation's transaction to complete.
java.lang.String	getTransactionType() Determines whether this operation is managed by a service or a container.
boolean	isAnonymousAccess() Determines whether an operation is set for anonymous access.
boolean	isOrchestrateable() Determines whether a service or any of its operations can be used within a process created in Workbench ES.

Field Detail

TX_TYPE_SERVICE

static final java.lang.String TX_TYPE_SERVICE

Represents a service type.

See Also:

Constant Field Values

TX_TYPE_CONTAINER

static final java.lang.String TX_TYPE_CONTAINER

Represents a container type.

See Also:

Constant Field Values

TX_TYPE_NONE

static final java.lang.String TX_TYPE_NONE

Represents no type.

See Also:

Constant Field Values

TX_PROPAGATION_REQUIRED

static final java.lang.String TX_PROPAGATION_REQUIRED

Represents a required propagation value.

See Also:

Constant Field Values

TX_PROPAGATION_SUPPORTS

static final java.lang.String TX_PROPAGATION_SUPPORTS

Represents a support propagation value.

See Also:

Constant Field Values

TX_PROPAGATION_MANDATORY

static final java.lang.String TX_PROPAGATION_MANDATORY

Represents a mandatory propagation value.

See Also:

Constant Field Values

TX_PROPAGATION_REQUIRES_NEW

static final java.lang.String TX_PROPAGATION_REQUIRES_NEW

Requires a new propagation value.

See Also:

Constant Field Values

TX_PROPAGATION_NOT_SUPPORTED

static final java.lang.String TX_PROPAGATION_NOT_SUPPORTED

Represents an unsupported propagation value.

See Also:

Constant Field Values

TX_PROPAGATION_NEVER

static final java.lang.String TX_PROPAGATION_NEVER

Represents a never propagation value.

See Also:

Constant Field Values

ACCESS_LEVEL_PRIVATE

static final short ACCESS_LEVEL_PRIVATE

Represents private access.

See Also:

Constant Field Values

ACCESS_LEVEL_PUBLIC

static final short ACCESS_LEVEL_PUBLIC

Represents public access.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Retrieves the name of the operation, which must be unique to the service.

Returns:

A string value that specifies the operation name.

getAccessLevel

short getAccessLevel()

Retrieves the access level of the operation. For example, if this operation has public access, then 0 is returned.

Returns:

A string value that represents the access level of the operation.

getDescription

java.lang.String getDescription()

Retrieves the description of the operation.

Returns:

A string value that specifies the description of the operation.

getLongLived

boolean getLongLived()

Determines whether the operation is a long-lived operation.

Returns:

Returns the value true if the operation is a long-lived operation.

getAttributes

java.util.Map getAttributes()

Retrieves a map of operation attributes.

Returns:

A java.util.Map object that contains operation attributes.

getInputParameter

InputParameter getInputParameter(java.lang.String aName)
                                 throws InputParameterNotFoundException

Retrieves the specified input parameter.

Parameters:

aName - The name of the input parameter.

Returns:

An InputParameter object that corresponds to the input parameter name.

Throws:

InputParameterNotFoundException - If an invalid output parameter name is specified.

getInputParameters

InputParameter[] getInputParameters()

Retrieves all input parameters that are expected by this operation.

Returns:

An array of InputParameter objects that are expected by this operation.

getOutputParameter

OutputParameter getOutputParameter(java.lang.String aName)
                                   throws OutputParameterNotFoundException

Retrieves the specified output parameter.

Parameters:

aName - The name of the output parameter.

Returns:

An OutputParameter object that corresponds to the output parameter name.

Throws:

OutputParameterNotFoundException - If an invalid output parameter name is specified.

getOutputParameters

OutputParameter[] getOutputParameters()

Returns all output parameters that are expected by this operation.

Returns:

An array of OutputParameter objects that are expected by this operation.

getTransactionType

java.lang.String getTransactionType()

Determines whether this operation is managed by a service or a container.

Returns:

One of the following values:

• SMT: Represents a service managed transaction.
• CMT: Represents a container managed transaction.

getTransactionPropagation

java.lang.String getTransactionPropagation()

Retrieves the transaction propagation value.

Returns:

One of the following values:

• Required
• Supports
• Mandatory
• Requires New
• Not Supported
• Never

getTransactionTimeout

int getTransactionTimeout()

Retrieves the number of seconds the container should wait for this operation's transaction to complete. If 0 is returned, the default transaction timeout configured for the underlying transaction provider is used.

Returns:

The number of seconds the container waits for this operation's transaction to complete.

getSmallIcon

byte[] getSmallIcon()

Retrieves the small icon for this operation.

Returns:

A byte array that represents the small icon for this operation.

getLargeIcon

byte[] getLargeIcon()

Retrieves the large icon representation of the operation.

Returns:

A byte array that represents the large icon for this operation.

getTitle

java.lang.String getTitle()

Retrieves the title of the service to which this operation belongs.

Returns:

A string value that represents the service title.

getHint

java.lang.String getHint()

Retrieves text that describes the purpose of the service to which this operation belongs.

Returns:

A string value that specifies the purpose of the service.

isOrchestrateable

boolean isOrchestrateable()

Determines whether a service or any of its operations can be used within a process created in Workbench ES.

Returns:

The value true if the service or any of its operations can be used within a process.

isAnonymousAccess

boolean isAnonymousAccess()

Determines whether an operation is set for anonymous access.

Returns:

The value true if this operation is set for anonymous access.

getSupportedConnectorIds

java.lang.String[] getSupportedConnectorIds()

Retrieves an array of connector identifiers, specifying which connectors can be used to set up endpoints for the service to which this operation belongs.

Returns:

A string array of connector identifiers.

getLayout

Layout getLayout()

Retrieves the layout defined for this operation, which is used to determine how the operation's parameters appear during process design.

Returns:

A Layout object that specifies the layout defined for this operation.

getFaults

Fault[] getFaults()

Retrieves an array of faults that make up the signature of this operation.

Returns:

An array of Fault objects that make up the signature of this operation.

getServiceConfiguration

ServiceConfiguration getServiceConfiguration()

Retrieves the service configuration to which this operation belongs.

Returns:

A ServiceConfiguration object that represents the service configuration to which this operation belongs.

getServiceId

java.lang.String getServiceId()

Retrieves the service identifier to which this operation belongs.

Returns:

A string value that specifies the service identifier.

getDeprecated

boolean getDeprecated()

Retrieves whether or not this operation is deprecated.

Returns:

A boolean value, true if the operation is deprecated, false otherwise

getDeprecatedSince

java.lang.String getDeprecatedSince()

Retrieves when this operation was deprecated.

Returns:

String containing when this operation was deprecated.

getReplacedBy

java.lang.String getReplacedBy()

Retrieves what this operation is replaced by.

Returns:

String containing what this operation is replaced by.

getSunsettingOn

java.lang.String getSunsettingOn()

Retrieves information about when this operation is expected to be removed.

Returns:

String containing information about when this operation is expected to be removed.