Package com.adobe.idp.dsc.registry.infomodel
Interfacepublic interface Operation

An Operation object contains metadata describing the operation within a document service.


Public Methods
 MethodDefined by
  
short getAccessLevel()
Retrieves the access level of the operation.
Operation
  
Map getAttributes()
Retrieves the a map of attributes that are interpreted and specific to the component from which the related document service was deployed.
Operation
  
String getDescription()
Retrieves the description of the operation.
Operation
  
Fault[] getFaults()
Retrieves an array of faults that make up the signature of this operation.
Operation
  
String getHint()
Short text that describes the purpose of a document service and is displayed within related user interfaces.
Operation
  
InputParameter getInputParameter(String aName)
Retrieves the specified input parameter.
Operation
  
InputParameter[] getInputParameters()
Retrieves all of the input parameters that are expected by this operation.
Operation
  
byte[] getLargeIcon()
Retrieves the large icon representation of the operation.
Operation
  
Layout getLayout()
Retrieves the layout defined for this operation, which is used to determine how the operation's parameters appear during process design.
Operation
  
boolean getLongLived()
Determines whether the operation is long-lived.
Operation
  
String getName()
Retrieves the name of the operation, which must be unique within the document service.
Operation
  
OutputParameter getOutputParameter(String aName)
Retrieves the specified output parameter.
Operation
  
OutputParameter[] getOutputParameters()
Returns all of the output parameters that are expected by this operation.
Operation
  
ServiceConfiguration getServiceConfiguration()
Retrieves the service configuration to which this operation belongs.
Operation
  
String getServiceId()
Retrieves the identifier of the service to which this operation belongs.
Operation
  
byte[] getSmallIcon()
Retrieves the small icon representation of the operation.
Operation
  
String[] getSupportedConnectorIds()
Retrieves an array of connector identifiers, specifying which connectors can be used to set up endpoints for a service.
Operation
  
String getTitle()
Retrieves the title of a document service.
Operation
  
String getTransactionPropagation()
Retrieves the transaction propagation value.
Operation
  
int getTransactionTimeout()
Retrieves the number of seconds the container should wait for this operation's transaction to complete.
Operation
  
String getTransactionType()
Determines whether this operation is managed by a service or a container.
Operation
  
boolean isAnonymousAccess()
Determines whether an operation is set for anonymous access.
Operation
  
boolean isOrchestrateable()
Determines whether a service or any of its operations can be used within an orchestration.
Operation
Public Constants
 ConstantDefined by
  ACCESS_LEVEL_PRIVATE
[static] Private access.
Operation
  ACCESS_LEVEL_PUBLIC
[static] Public access.
Operation
  TX_PROPAGATION_MANDATORY
[static] Mandatory propagation value.
Operation
  TX_PROPAGATION_NEVER
[static] Never propagation value.
Operation
  TX_PROPAGATION_NOT_SUPPORTED
[static] Unsupported propagation value.
Operation
  TX_PROPAGATION_REQUIRED
[static] Required propagation value.
Operation
  TX_PROPAGATION_REQUIRES_NEW
[static] Requires new propagation value.
Operation
  TX_PROPAGATION_SUPPORTS
[static] Support propagation value.
Operation
  TX_TYPE_CONTAINER
[static] Container type.
Operation
  TX_TYPE_NONE
[static] No type.
Operation
  TX_TYPE_SERVICE
[static] Service type.
Operation
Method Detail
getAccessLevel()
public short getAccessLevel()

Retrieves the access level of the operation.

Returns
The access level of the operation.
getAttributes() 
public Map getAttributes()

Retrieves the a map of attributes that are interpreted and specific to the component from which the related document service was deployed.

Returns
A map of attributes.
getDescription() 
public String getDescription()

Retrieves the description of the operation.

Returns
The description of the operation.
getFaults() 
public Fault[] getFaults()

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

Returns
An array of faults that make up the signature of this operation.
getHint() 
public String getHint()

Short text that describes the purpose of a document service and is displayed within related user interfaces.

Returns
Short text that describes the purpose of a document service.
getInputParameter() 
public InputParameter getInputParameter(String aName)

Retrieves the specified input parameter.

Parameters

aName — The name of the input parameter.

Returns
The input parameter.
getInputParameters() 
public InputParameter[] getInputParameters()

Retrieves all of the input parameters that are expected by this operation.

Returns
All of the input parameters that are expected by this operation.
getLargeIcon() 
public byte[] getLargeIcon()

Retrieves the large icon representation of the operation.

Returns
The large icon representation of the operation.
getLayout() 
public Layout getLayout()

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

Returns
The layout defined for this operation.
getLongLived() 
public boolean getLongLived()

Determines whether the operation is long-lived.

Returns
true if the operation is long-lived, false otherwise.
getName() 
public String getName()

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

Returns
The name of the operation.
getOutputParameter() 
public OutputParameter getOutputParameter(String aName)

Retrieves the specified output parameter.

Parameters

aName — The name of the output parameter.

Returns
The output parameter.
getOutputParameters() 
public OutputParameter[] getOutputParameters()

Returns all of the output parameters that are expected by this operation.

Returns
All of the output parameters that are expected by this operation.
getServiceConfiguration() 
public ServiceConfiguration getServiceConfiguration()

Retrieves the service configuration to which this operation belongs.

Returns
The service configuration to which this operation belongs.
getServiceId() 
public String getServiceId()

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

Returns
The identifier of the service to which this operation belongs.
getSmallIcon() 
public byte[] getSmallIcon()

Retrieves the small icon representation of the operation.

Returns
The small icon representation of the operation.
getSupportedConnectorIds() 
public String[] getSupportedConnectorIds()

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

Returns
An array of connector identifiers.
getTitle() 
public String getTitle()

Retrieves the title of a document service. This value is used when displaying a service.

Returns
The title of a document service.
getTransactionPropagation() 
public String getTransactionPropagation()

Retrieves the transaction propagation value.

Returns
One of the following values:
  • "Required"
  • "Supports"
  • "Mandatory"
  • "Requires New"
  • "Not Supported"
  • "Never"
getTransactionTimeout() 
public 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 will be used.

Returns
The number of seconds the container should wait for this operation's transaction to complete.
getTransactionType() 
public String getTransactionType()

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

Returns
One of the following values:
  • "SMT": Service Managed Transaction
  • "CMT": Container Managed Transaction
isAnonymousAccess() 
public boolean isAnonymousAccess()

Determines whether an operation is set for anonymous access.

Returns
true if an operation is set for anonymous access, false otherwise.
isOrchestrateable() 
public boolean isOrchestrateable()

Determines whether a service or any of its operations can be used within an orchestration.

Returns
true if the service or any of its operations can be used within an orchestration, false otherwise.
Constant Detail
ACCESS_LEVEL_PRIVATEConstant
public static final ACCESS_LEVEL_PRIVATE

Private access.

ACCESS_LEVEL_PUBLICConstant 
public static final ACCESS_LEVEL_PUBLIC

Public access.

TX_PROPAGATION_MANDATORYConstant 
public static final TX_PROPAGATION_MANDATORY

Mandatory propagation value.

TX_PROPAGATION_NEVERConstant 
public static final TX_PROPAGATION_NEVER

Never propagation value.

TX_PROPAGATION_NOT_SUPPORTEDConstant 
public static final TX_PROPAGATION_NOT_SUPPORTED

Unsupported propagation value.

TX_PROPAGATION_REQUIREDConstant 
public static final TX_PROPAGATION_REQUIRED

Required propagation value.

TX_PROPAGATION_REQUIRES_NEWConstant 
public static final TX_PROPAGATION_REQUIRES_NEW

Requires new propagation value.

TX_PROPAGATION_SUPPORTSConstant 
public static final TX_PROPAGATION_SUPPORTS

Support propagation value.

TX_TYPE_CONTAINERConstant 
public static final TX_TYPE_CONTAINER

Container type.

TX_TYPE_NONEConstant 
public static final TX_TYPE_NONE

No type.

TX_TYPE_SERVICEConstant 
public static final TX_TYPE_SERVICE

Service type.




© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Sep 27 2007, 8:38 AM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/idp/dsc/registry/infomodel/Operation.html