com.ibm.carma.model
Interface CustomParameter

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

public interface CustomParameter
extends DefaultParameter

A representation of the model object 'Custom Parameter'. A description of a custom parameter required to be fed to a custom action before action execution

The following features are supported:

See Also:
ModelPackage.getCustomParameter(), Action

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.lang.String getPrompt()
          Returns the value of the 'Prompt' attribute.
 boolean isConstant()
          Returns the value of the 'Constant' attribute.
 
Methods inherited from interface com.ibm.carma.model.DefaultParameter
getDefaultValue
 
Methods inherited from interface com.ibm.carma.model.Parameter
getDescription, getLength, getName, getParameterId, getType
 
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

getPrompt

java.lang.String getPrompt()
Returns the value of the 'Prompt' attribute. Prompt that should be displayed when querying for the parameter value

Returns:
the value of the 'Prompt' attribute.
See Also:
ModelPackage.getCustomParameter_Prompt()

isConstant

boolean isConstant()
Returns the value of the 'Constant' attribute.

If the custom parameter is a constant value that means that the value of the parameter cannot be changed and must match the Default value of the parameter

Returns true if the custom parameter is a constant value

Returns:
the value of the 'Constant' attribute.
See Also:
ModelPackage.getCustomParameter_Constant()