com.ibm.carma.model
Interface Action

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

public interface Action
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Action'. Custom action description for the CARMA system related to a specific Repsitory manager

The following features are supported:

See Also:
ModelPackage.getAction(), RepositoryManager.getActions()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.lang.String getActionId()
          Returns the value of the 'Action Id' attribute.
 java.lang.String getDescription()
          Returns the value of the 'Description' attribute.
 java.lang.String getName()
          Returns the value of the 'Name' attribute.
 org.eclipse.emf.common.util.EList getParameters()
          Returns the value of the 'Parameters' containment reference list.
 org.eclipse.emf.common.util.EList getReturnValues()
          Returns the value of the 'Return Values' containment reference list.
 org.eclipse.emf.common.util.EList getSubActions()
          Returns the list of child actions that are executed when the action represents a multiple step process
 boolean isCustom()
          Returns the value of the 'Custom' attribute.
 boolean isDisabled()
          Returns the value of the 'Disabled' attribute.
 boolean isMultiAction()
          Denotes that the action represents a series of actions executed on the CARMA system.
 boolean isUnsupported()
          Returns the value of the 'Unsupported' attribute.
 void setUnsupported(boolean value)
          Sets the value of the 'Unsupported' attribute.
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getActionId

java.lang.String getActionId()
Returns the value of the 'Action Id' attribute.

The identifier of the action to be executed on the CARMA host. The CARMA host identifies specific action by discrete identifiers that can be found in the CARMA configuration. The action may either be an identifier of a default CARMA methods or a custom action identifier.

CARMA defines a set of default action identifiers for host methods. The CARMA model attempts to abstract away the host methods for client users and as such the host method identifiers may not match up with the method identifiers on the client. The CARMA Model identifiers are internally mapped to the appropriate CARMA host identifier and provided a host-independent means of inspecting customized actions.

The set of default actions for the CARMA model methods can be found in the ActionIdentifier class. The set of default actions for the CARMA host methods can be found in the CARMAActionIdentifier class. Both sets of action identifiers can be used with the CustomActionAccepter.findActionFor(String) method.

Unique identifier of the action within the Repository Manager

Returns:
the value of the 'Action Id' attribute.
See Also:
ModelPackage.getAction_ActionId()

getName

java.lang.String getName()
Returns the value of the 'Name' attribute. Displayable name of the action

Returns:
the value of the 'Name' attribute.
See Also:
ModelPackage.getAction_Name()

getDescription

java.lang.String getDescription()
Returns the value of the 'Description' attribute. Description of the action

Returns:
the value of the 'Description' attribute.
See Also:
ModelPackage.getAction_Description()

isDisabled

boolean isDisabled()
Returns the value of the 'Disabled' attribute. The default value is "false".

The flag denotes that the Action is disabled for the Repository Manager and the action will not be executed on the host if called.

Returns true if the action is disabled for the Repository Manager. If the action is disabled then attempted execution of the method will throw an exception.

Returns:
the value of the 'Disabled' attribute.
See Also:
ModelPackage.getAction_Disabled()

isUnsupported

boolean isUnsupported()
Returns the value of the 'Unsupported' attribute. The default value is "false".

The action is marked as unsupported if the CARMA host/RAM returns an error code denoting that the given action is not supported for the Repository Manager. The unsupported flag simply flags that the action has returned an unsupported code. An unsupported action will be executed on the host if the action is called.

Returns true if the action as unsupported for the Repository Manager content. If an action is unsupported then attempted execution of the method will be attempted but may return unsupported from the CARMA system.

Returns:
the value of the 'Unsupported' attribute.
See Also:
setUnsupported(boolean), ModelPackage.getAction_Unsupported()

setUnsupported

void setUnsupported(boolean value)
Sets the value of the 'Unsupported' attribute.

Parameters:
value - the new value of the 'Unsupported' attribute.
See Also:
isUnsupported()

isCustom

boolean isCustom()
Returns the value of the 'Custom' attribute.

Returns true for an action which is a "custom" action for the Repository manager where the actionId of the action is not in the range of default action identifiers

Denotes an action as a "custom" action for the Repository manager

Returns:
the value of the 'Custom' attribute.
See Also:
ModelPackage.getAction_Custom()

isMultiAction

boolean isMultiAction()
Denotes that the action represents a series of actions executed on the CARMA system.

Returns:
true when the action represents a series of actions

getSubActions

org.eclipse.emf.common.util.EList getSubActions()
Returns the list of child actions that are executed when the action represents a multiple step process

Returns:
list of child actions for the multi-action

getParameters

org.eclipse.emf.common.util.EList getParameters()
Returns the value of the 'Parameters' containment reference list. The list contents are of type CustomParameter.

The custom parameters define the set of parameters that are required to execute the action. The parameters must be passed to the method execution in order to process and send the method call to the CARMA host.

List of custom parameters defined for the action.

Returns:
the value of the 'Parameters' containment reference list.
See Also:
ModelPackage.getAction_Parameters()

getReturnValues

org.eclipse.emf.common.util.EList getReturnValues()
Returns the value of the 'Return Values' containment reference list. The list contents are of type ReturnValue.

The custom return values define the set of return values that are expected to be returned from the action execution on the host. The return values are processed on the client and returned from method calls to the CARMA host.

The return values defined for the action

Returns:
the value of the 'Return Values' containment reference list.
See Also:
ModelPackage.getAction_ReturnValues()