org.modelio.metamodel.mda

Interface ModuleParameter

All Superinterfaces:

java.lang.Comparable<MObject>, Element, MObject, ModelElement

public interface ModuleParameter
extends ModelElement

ModuleParameter v0.0.9054 Definition of a module parameter.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MNAME The metaclass simple name.
static java.lang.String	MQNAME The metaclass qualified name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultValue() Getter for attribute 'ModuleParameter.DefaultValue' Metamodel description:
EnumeratedPropertyType	getEnumType() Getter for relation 'ModuleParameter->EnumType' Metamodel description: Enumeration used by the parameter.
java.lang.String	getGroupName() Getter for attribute 'ModuleParameter.GroupName' Metamodel description: Name of the parameter group.
ModuleComponent	getOwner() Getter for relation 'ModuleParameter->Owner' Metamodel description: null
ModuleParameterType	getType() Getter for attribute 'ModuleParameter.Type' Metamodel description: Type of the parameter.
boolean	isIsApiRead() Getter for attribute 'ModuleParameter.IsApiRead' Metamodel description: if true, the parameter can be read with the modules API.
boolean	isIsApiWrite() Getter for attribute 'ModuleParameter.IsApiWrite' Metamodel description: if true, the parameter can be set with the modules API.
boolean	isIsUserRead() Getter for attribute 'ModuleParameter.IsUserRead' Metamodel description: If true, the parameter is visible in the module configuration dialog.
boolean	isIsUserWrite() Getter for attribute 'ModuleParameter.IsUserWrite' Metamodel description: If true and IsUserRead is true, the parameter is modifiable in the module configuration dialog.
void	setDefaultValue(java.lang.String value) Setter for attribute 'ModuleParameter.DefaultValue' Metamodel description:
void	setEnumType(EnumeratedPropertyType value) Setter for relation 'ModuleParameter->EnumType' Metamodel description: Enumeration used by the parameter.
void	setGroupName(java.lang.String value) Setter for attribute 'ModuleParameter.GroupName' Metamodel description: Name of the parameter group.
void	setIsApiRead(boolean value) Setter for attribute 'ModuleParameter.IsApiRead' Metamodel description: if true, the parameter can be read with the modules API.
void	setIsApiWrite(boolean value) Setter for attribute 'ModuleParameter.IsApiWrite' Metamodel description: if true, the parameter can be set with the modules API.
void	setIsUserRead(boolean value) Setter for attribute 'ModuleParameter.IsUserRead' Metamodel description: If true, the parameter is visible in the module configuration dialog.
void	setIsUserWrite(boolean value) Setter for attribute 'ModuleParameter.IsUserWrite' Metamodel description: If true and IsUserRead is true, the parameter is modifiable in the module configuration dialog.
void	setOwner(ModuleComponent value) Setter for relation 'ModuleParameter->Owner' Metamodel description: null
void	setType(ModuleParameterType value) Setter for attribute 'ModuleParameter.Type' Metamodel description: Type of the parameter.

Methods inherited from interface org.modelio.metamodel.uml.infrastructure.ModelElement

addStereotype, getAttached, getAttached, getDependsOnDependency, getDependsOnDependency, getDescriptor, getDescriptor, getExtension, getExtension, getImpactDependsOn, getImpactDependsOn, getImpactedDependency, getImpactedDependency, getImpactImpacted, getImpactImpacted, getLocalProperties, getLocalProperty, getMatrix, getMatrix, getName, getNote, getNote, getNote, getNoteContent, getNoteContent, getNoteContent, getProduct, getProduct, getProperties, getProperties, getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getStereotype, getTag, getTag, getTag, getTag, getTag, getTagValue, getTagValue, getTagValue, getTagValues, getTagValues, getTagValues, isStereotyped, isStereotyped, isTagged, isTagged, isTagged, putNoteContent, putNoteContent, putNoteContent, putTagValue, putTagValue, putTagValue, putTagValues, putTagValues, putTagValues, removeNotes, removeNotes, removeNotes, removeStereotypes, removeTags, removeTags, removeTags, setLocalProperties, setLocalProperty, setName, setProperty, setProperty, setProperty, setProperty

Methods inherited from interface org.modelio.metamodel.uml.infrastructure.Element

getAddedToQuery, getAddedToQuery, getCausedImpact, getCausedImpact, getDiagramElement, getDiagramElement

Methods inherited from interface org.modelio.vcore.smkernel.mapi.MObject

accept, delete, getCompositionChildren, getCompositionOwner, getMClass, getStatus, getUuid, isDeleted, isModifiable, isShell, isValid, mGet, mGet, mSet

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

MNAME

static final java.lang.String MNAME

The metaclass simple name.

See Also:

Constant Field Values

MQNAME

static final java.lang.String MQNAME

The metaclass qualified name.

See Also:

Constant Field Values

Method Detail

getGroupName

java.lang.String getGroupName()

Getter for attribute 'ModuleParameter.GroupName' Metamodel description: Name of the parameter group. Allow module parameters to be sorted by groups.

setGroupName

void setGroupName(java.lang.String value)

Setter for attribute 'ModuleParameter.GroupName' Metamodel description: Name of the parameter group. Allow module parameters to be sorted by groups.

getType

ModuleParameterType getType()

Getter for attribute 'ModuleParameter.Type' Metamodel description: Type of the parameter. If the type is TYPE_PARAM_ENUM, the 'EnumType' association must refer to an Enumeration.

setType

void setType(ModuleParameterType value)

Setter for attribute 'ModuleParameter.Type' Metamodel description: Type of the parameter. If the type is TYPE_PARAM_ENUM, the 'EnumType' association must refer to an Enumeration.

isIsUserRead

boolean isIsUserRead()

Getter for attribute 'ModuleParameter.IsUserRead' Metamodel description: If true, the parameter is visible in the module configuration dialog.

setIsUserRead

void setIsUserRead(boolean value)

Setter for attribute 'ModuleParameter.IsUserRead' Metamodel description: If true, the parameter is visible in the module configuration dialog.

isIsUserWrite

boolean isIsUserWrite()

Getter for attribute 'ModuleParameter.IsUserWrite' Metamodel description: If true and IsUserRead is true, the parameter is modifiable in the module configuration dialog.

setIsUserWrite

void setIsUserWrite(boolean value)

Setter for attribute 'ModuleParameter.IsUserWrite' Metamodel description: If true and IsUserRead is true, the parameter is modifiable in the module configuration dialog.

isIsApiRead

boolean isIsApiRead()

Getter for attribute 'ModuleParameter.IsApiRead' Metamodel description: if true, the parameter can be read with the modules API.

setIsApiRead

void setIsApiRead(boolean value)

Setter for attribute 'ModuleParameter.IsApiRead' Metamodel description: if true, the parameter can be read with the modules API.

isIsApiWrite

boolean isIsApiWrite()

Getter for attribute 'ModuleParameter.IsApiWrite' Metamodel description: if true, the parameter can be set with the modules API.

setIsApiWrite

void setIsApiWrite(boolean value)

Setter for attribute 'ModuleParameter.IsApiWrite' Metamodel description: if true, the parameter can be set with the modules API.

getDefaultValue

java.lang.String getDefaultValue()

Getter for attribute 'ModuleParameter.DefaultValue' Metamodel description:

Default value for the module parameter, written as a string.

setDefaultValue

void setDefaultValue(java.lang.String value)

Setter for attribute 'ModuleParameter.DefaultValue' Metamodel description:

Default value for the module parameter, written as a string.

getOwner

ModuleComponent getOwner()

Getter for relation 'ModuleParameter->Owner' Metamodel description: null

setOwner

void setOwner(ModuleComponent value)

Setter for relation 'ModuleParameter->Owner' Metamodel description: null

getEnumType

EnumeratedPropertyType getEnumType()

Getter for relation 'ModuleParameter->EnumType' Metamodel description: Enumeration used by the parameter. when the attribute "Type" is TYPE_PARAM_ENUM.

setEnumType

void setEnumType(EnumeratedPropertyType value)

Setter for relation 'ModuleParameter->EnumType' Metamodel description: Enumeration used by the parameter. when the attribute "Type" is TYPE_PARAM_ENUM.