Packagecom.adobe.idp.dsc.registry.infomodel.layout
Interfacepublic interface Operation

created: Jul 8, 2006 7:10:23 AM


Packagecom.adobe.idp.dsc.registry.infomodel
Interfacepublic interface Operation

An Operation object contains metadata describing a service operation.


Public Methods
 MethodDefined By
  
short getAccessLevel()
Retrieves the access level of the operation.
Operation
  
Map getAttributes()
Retrieves a map of operation attributes.
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()
Retrieves text that describes the purpose of the service to which this operation belongs.
Operation
  
InputParameter getInputParameter(String aName)
Retrieves the specified input parameter.
Operation
  
InputParameter[] getInputParameters()
Retrieves all 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 a long-lived operation.
Operation
  
String getName()
Retrieves the name of the operation, which must be unique to the service.
Operation
  
OutputParameter getOutputParameter(String aName)
Retrieves the specified output parameter.
Operation
  
OutputParameter[] getOutputParameters()
Returns all 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 service identifier to which this operation belongs.
Operation
  
byte[] getSmallIcon()
Retrieves the small icon for this operation.
Operation
  
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.
Operation
  
String getTitle()
Retrieves the title of the service to which this operation belongs.
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 a process created in Workbench ES.
Operation
Public Constants
 ConstantDefined By
  ACCESS_LEVEL_PRIVATE
[static] Represents private access.
Operation
  ACCESS_LEVEL_PUBLIC
[static] Represents public access.
Operation
  TX_PROPAGATION_MANDATORY
[static] Represents a mandatory propagation value.
Operation
  TX_PROPAGATION_NEVER
[static] Represents a never propagation value.
Operation
  TX_PROPAGATION_NOT_SUPPORTED
[static] Represents an unsupported propagation value.
Operation
  TX_PROPAGATION_REQUIRED
[static] Represents a required propagation value.
Operation
  TX_PROPAGATION_REQUIRES_NEW
[static] Requires a new propagation value.
Operation
  TX_PROPAGATION_SUPPORTS
[static] Represents a support propagation value.
Operation
  TX_TYPE_CONTAINER
[static] Represents a container type.
Operation
  TX_TYPE_NONE
[static] Represents no type.
Operation
  TX_TYPE_SERVICE
[static] Represents a service type.
Operation
Method Detail
getAccessLevel()
public 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.
getAttributes() 
public Map getAttributes()

Retrieves a map of operation attributes.

Returns
A java.util.Map object that contains operation attributes.
getDescription() 
public String getDescription()

Retrieves the description of the operation.

Returns
A string value that specifies 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 Fault objects that make up the signature of this operation.
getHint() 
public 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.
getInputParameter() 
public InputParameter getInputParameter(String aName)

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() 
public InputParameter[] getInputParameters()

Retrieves all input parameters that are expected by this operation.

Returns
An array of InputParameter objects that are expected by this operation.
getLargeIcon() 
public byte[] getLargeIcon()

Retrieves the large icon representation of the operation.

Returns
A byte array that represents the large icon for this 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
A Layout object that specifies the layout defined for this operation.
getLongLived() 
public boolean getLongLived()

Determines whether the operation is a long-lived operation.

Returns
Returns the value true if the operation is a long-lived operation.
getName() 
public String getName()

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

Returns
A string value that specifies the operation name.
getOutputParameter() 
public OutputParameter getOutputParameter(String aName)

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() 
public OutputParameter[] getOutputParameters()

Returns all output parameters that are expected by this operation.

Returns
An array of OutputParameter objects that are expected by this operation.
getServiceConfiguration() 
public 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() 
public String getServiceId()

Retrieves the service identifier to which this operation belongs.

Returns
A string value that specifies the service identifier.
getSmallIcon() 
public byte[] getSmallIcon()

Retrieves the small icon for this operation.

Returns
A byte array that represents the small icon for this operation.
getSupportedConnectorIds() 
public 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.
getTitle() 
public String getTitle()

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

Returns
A string value that represents the service title.
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 is used.

Returns
The number of seconds the container waits 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: Represents a service managed transaction.
  • CMT: Represents a container managed transaction.
isAnonymousAccess() 
public boolean isAnonymousAccess()

Determines whether an operation is set for anonymous access.

Returns
The value true if this operation is set for anonymous access.
isOrchestrateable() 
public 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.
Constant Detail
ACCESS_LEVEL_PRIVATEConstant
public static final ACCESS_LEVEL_PRIVATE

Represents private access.

ACCESS_LEVEL_PUBLICConstant 
public static final ACCESS_LEVEL_PUBLIC

Represents public access.

TX_PROPAGATION_MANDATORYConstant 
public static final TX_PROPAGATION_MANDATORY

Represents a mandatory propagation value.

TX_PROPAGATION_NEVERConstant 
public static final TX_PROPAGATION_NEVER

Represents a never propagation value.

TX_PROPAGATION_NOT_SUPPORTEDConstant 
public static final TX_PROPAGATION_NOT_SUPPORTED

Represents an unsupported propagation value.

TX_PROPAGATION_REQUIREDConstant 
public static final TX_PROPAGATION_REQUIRED

Represents a required propagation value.

TX_PROPAGATION_REQUIRES_NEWConstant 
public static final TX_PROPAGATION_REQUIRES_NEW

Requires a new propagation value.

TX_PROPAGATION_SUPPORTSConstant 
public static final TX_PROPAGATION_SUPPORTS

Represents a support propagation value.

TX_TYPE_CONTAINERConstant 
public static final TX_TYPE_CONTAINER

Represents a container type.

TX_TYPE_NONEConstant 
public static final TX_TYPE_NONE

Represents no type.

TX_TYPE_SERVICEConstant 
public static final TX_TYPE_SERVICE

Represents a service type.




© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Wed Oct 1 2008, 10:46 PM -04:00

 

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

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