com.ibm.carma.model
Interface Parameter

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
CustomParameter, DefaultParameter, Field, ReturnValue

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

A representation of the model object 'Parameter'. A description of a parameter defines data inputs/outputs from a custom action during custom action execution

The following features are supported:

See Also:
ModelPackage.getParameter()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.lang.String getDescription()
          Returns the value of the 'Description' attribute.
 int getLength()
          Returns the value of the 'Length' attribute.
 java.lang.String getName()
          Returns the value of the 'Name' attribute.
 java.lang.String getParameterId()
          Returns the value of the 'Parameter Id' attribute.
 VariableType getType()
          Returns the value of the 'Type' 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

getParameterId

java.lang.String getParameterId()
Returns the value of the 'Parameter Id' attribute. Parameter identifier

Returns:
the value of the 'Parameter Id' attribute.
See Also:
ModelPackage.getParameter_ParameterId()

getName

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

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

getDescription

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

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

getType

VariableType getType()
Returns the value of the 'Type' attribute. The literals are from the enumeration VariableType.

The object type that the parameter value represents

parameter type

Returns:
the value of the 'Type' attribute.
See Also:
VariableType, ModelPackage.getParameter_Type()

getLength

int getLength()
Returns the value of the 'Length' attribute.

The length attribute only applies when the type of the parameter is String. The length attribute denotes the maximum length of the string value that is allowed for the parameter

Maximum length of the parameter

Returns:
the value of the 'Length' attribute.
See Also:
ModelPackage.getParameter_Length()