org.eclipse.datatools.connectivity.oda.design
Interface ParameterDefinition

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

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

Top-level parameter definition; may be input and/or output mode. Parameter may be of scalar or complex type.

The following features are supported:

See Also:
DesignPackage.getParameterDefinition()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void addDefaultValue(java.lang.Object aValue)
          A convenience method to append a default value to this parameter's default value collection.
 DataElementAttributes getAttributes()
          Returns the value of the 'Attributes' containment reference.
 java.lang.String getDefaultScalarValue()
          A convenience method to return this parameter's default input value in String.
 int getDefaultValueCount()
          A convenience method to get the number of default values specified for this parameter.
 StaticValues getDefaultValues()
          A convenience method to return this parameter's collection of default input values.
 InputElementAttributes getEditableInputElementAttributes()
          A short-cut method that returns the value of the 'Element Attributes' containment referenced by the 'Input Attributes' containment reference.
 ParameterFields getFields()
          Returns the value of the 'Fields' containment reference.
 ParameterMode getInOutMode()
          Returns the value of the 'In Out Mode' attribute.
 InputParameterAttributes getInputAttributes()
          Returns the value of the 'Input Attributes' containment reference.
 OutputElementAttributes getOutputUsageHints()
          Returns the value of the 'Output Usage Hints' containment reference.
 boolean isInput()
          Indicates whether this parameter is defined to take input value.
 boolean isOutput()
          Indicates whether this parameter is defined to have output value.
 boolean isScalar()
          Indicates whether this is a scalar parameter.
 boolean isSetInOutMode()
          Returns whether the value of the 'In Out Mode' attribute is set.
 void setAttributes(DataElementAttributes value)
          Sets the value of the 'Attributes' containment reference.
 void setDefaultScalarValue(java.lang.String value)
          A convenience method to set this parameter's default input value in String.
 void setFields(ParameterFields value)
          Sets the value of the 'Fields' containment reference.
 void setInOutMode(ParameterMode value)
          Sets the value of the 'In Out Mode' attribute.
 void setInputAttributes(InputParameterAttributes value)
          Sets the value of the 'Input Attributes' containment reference.
 void setOutputUsageHints(OutputElementAttributes value)
          Sets the value of the 'Output Usage Hints' containment reference.
 void unsetInOutMode()
          Unsets the value of the 'In Out Mode' 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

isInput

boolean isInput()
Indicates whether this parameter is defined to take input value.

Returns:
true if this parameter is defined to take input value; false otherwise.
See Also:
getInOutMode()

isOutput

boolean isOutput()
Indicates whether this parameter is defined to have output value.

Returns:
true if this parameter is defined to have output value; false otherwise.
See Also:
getInOutMode()

isScalar

boolean isScalar()
Indicates whether this is a scalar parameter.

Returns:
true if this parameter has a scalar data type; false if it is a complex parameter with nested fields.
See Also:
getFields()

getDefaultScalarValue

java.lang.String getDefaultScalarValue()
A convenience method to return this parameter's default input value in String.

Returns:
the value of the parameter InputElementAttributes 'Default Scalar Value' attribute; returns null if this is not a scalar input parameter.
Since:
3.0.3
See Also:
setDefaultScalarValue(String), DesignPackage.getInputElementAttributes_DefaultScalarValue()

setDefaultScalarValue

void setDefaultScalarValue(java.lang.String value)
A convenience method to set this parameter's default input value in String. The specified value is applied only if this is defined as a scalar input parameter.

Parameters:
value - the new value of the parameter InputElementAttributes 'Default Scalar Value' attribute.
Since:
3.0.3
See Also:
getDefaultScalarValue(), DesignPackage.getInputElementAttributes_DefaultScalarValue()

getDefaultValues

StaticValues getDefaultValues()
A convenience method to return this parameter's collection of default input values.

Returns:
the collection of default values; may be null or empty
Since:
3.2 (DTP 1.7)

getDefaultValueCount

int getDefaultValueCount()
A convenience method to get the number of default values specified for this parameter.

Returns:
number of default values
Since:
3.2 (DTP 1.7)

addDefaultValue

void addDefaultValue(java.lang.Object aValue)
A convenience method to append a default value to this parameter's default value collection. It is the responsibility of the caller to ensure compatible type of value object is added to the collection.

Parameters:
aValue - the default value to add; may be null
Since:
3.2 (DTP 1.7)

getInOutMode

ParameterMode getInOutMode()
Returns the value of the 'In Out Mode' attribute. The default value is "In". The literals are from the enumeration ParameterMode.

Returns:
the value of the 'In Out Mode' attribute.
See Also:
ParameterMode, isSetInOutMode(), unsetInOutMode(), setInOutMode(ParameterMode), DesignPackage.getParameterDefinition_InOutMode()

setInOutMode

void setInOutMode(ParameterMode value)
Sets the value of the 'In Out Mode' attribute.

Parameters:
value - the new value of the 'In Out Mode' attribute.
See Also:
ParameterMode, isSetInOutMode(), unsetInOutMode(), getInOutMode()

unsetInOutMode

void unsetInOutMode()
Unsets the value of the 'In Out Mode' attribute.

See Also:
isSetInOutMode(), getInOutMode(), setInOutMode(ParameterMode)

isSetInOutMode

boolean isSetInOutMode()
Returns whether the value of the 'In Out Mode' attribute is set.

Returns:
whether the value of the 'In Out Mode' attribute is set.
See Also:
unsetInOutMode(), getInOutMode(), setInOutMode(ParameterMode)

getAttributes

DataElementAttributes getAttributes()
Returns the value of the 'Attributes' containment reference. Attributes applicable to both input and output parameter mode.

Returns:
the value of the 'Attributes' containment reference.
See Also:
setAttributes(DataElementAttributes), DesignPackage.getParameterDefinition_Attributes()

setAttributes

void setAttributes(DataElementAttributes value)
Sets the value of the 'Attributes' containment reference.

Parameters:
value - the new value of the 'Attributes' containment reference.
See Also:
getAttributes()

getInputAttributes

InputParameterAttributes getInputAttributes()
Returns the value of the 'Input Attributes' containment reference. Required for input parameter.

Returns:
the value of the 'Input Attributes' containment reference.
See Also:
setInputAttributes(InputParameterAttributes), DesignPackage.getParameterDefinition_InputAttributes()

getEditableInputElementAttributes

InputElementAttributes getEditableInputElementAttributes()
A short-cut method that returns the value of the 'Element Attributes' containment referenced by the 'Input Attributes' containment reference. If no reference is set, a new instance is assigned and returned.

Returns:
the value of the 'Element Attributes' containment reference.
Since:
3.0.5
See Also:
getInputAttributes()

setInputAttributes

void setInputAttributes(InputParameterAttributes value)
Sets the value of the 'Input Attributes' containment reference.

Parameters:
value - the new value of the 'Input Attributes' containment reference.
See Also:
getInputAttributes()

getOutputUsageHints

OutputElementAttributes getOutputUsageHints()
Returns the value of the 'Output Usage Hints' containment reference. Optional for an output parameter.

Returns:
the value of the 'Output Usage Hints' containment reference.
See Also:
setOutputUsageHints(OutputElementAttributes), DesignPackage.getParameterDefinition_OutputUsageHints()

setOutputUsageHints

void setOutputUsageHints(OutputElementAttributes value)
Sets the value of the 'Output Usage Hints' containment reference.

Parameters:
value - the new value of the 'Output Usage Hints' containment reference.
See Also:
getOutputUsageHints()

getFields

ParameterFields getFields()
Returns the value of the 'Fields' containment reference. Applicable to complex parameter only.

Returns:
the value of the 'Fields' containment reference.
See Also:
setFields(ParameterFields), DesignPackage.getParameterDefinition_Fields()

setFields

void setFields(ParameterFields value)
Sets the value of the 'Fields' containment reference.

Parameters:
value - the new value of the 'Fields' containment reference.
See Also:
getFields()