Package de.mid.innovator.srv2api.icw2class

Interface CLParameter

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, CLConnectAbleElement, CLDeclarationAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELMultiplicityAble, ELMultiplicityAbleTypedElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELTypedElement, ELUUIDAble, ELValueContainerAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

public interface CLParameter
extends ADHistoryAble, CLDeclarationAble, CLConnectAbleElement, ELMultiplicityAbleTypedElement, MMLabelTextAttachmentAble

A parameter is a specification of an argument used to pass information into or out of an invocation of a behavioral feature. It has a type and may have a multiplicity and an optional default value.

See Also:

CLParameterHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CLParameter.VAttr

Method Summary

Modifier and Type	Method	Description
java.util.List<ACParamNode>	getActivityParameterNode(K_CONTROL_OPTION... behaviourFlags)	Activity parameter is an object node at the beginning or end of flows used for accepting inputs to an activity and providing outputs from it.
java.lang.String	getDefaultValue()	Specifies a string that represents a value to be used when no argument is supplied for the parameter.
K_PARAM_DIRKIND	getDirection()	Specifies the direction kind of this parameter.
CLBehavioralFeature	getOwnerFormalParam()	The behavioral feature owning this parameter.
BEBehavior	getOwningBehavior()	The behavior owning this parameter.
CLOperation	getOwningOperation()	The operation owning this parameter.
CLParameterAble	getOwningParameterAble()	The element owning this parameter.
java.util.List<CLParameterSet>	getParameterSet()	All CLParameterSet this CLParameter is contained in.
<T extends ANPin> java.util.List<T>	getPin(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	If the CLParameter is assigned to a BEBehavior, all pins at a ANCallBehavior invoking this BEBehavior and belonging to this CLParameter will be returned.
<T extends ANPin> java.util.List<T>	getPin(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getPin and filters its return values according to the given stereotype value.
CLClassifier	getTypingClassifier()	The classifier used as type for this parameter.
CLTemplateParameterAbleClass	getTypingTemplateParameterAbleClass()	The class used as type for this parameter.
boolean	isEligibleForParameterSet(CLParameterSet refObj)	Checks for a given argument refObj if the parameter is or would be valid in this parameter CLParameterSet.
boolean	isException()	Informs whether an output parameter may emit a value to the exclusion of the other outputs.
boolean	isInput()	Is true if the parameter provides the behavior with an input.
boolean	isOutput()	Is true if the parameter carries an output of the behavior.
boolean	isReturn()	True, if this parameter has the 'return' direction.
boolean	isStream()	Informs whether an input parameter may accept values while its behavior is executing or whether an output parameter post values while the behavior is executing.
void	setDefaultValue(java.lang.String value)	Set the value of Attribut DefaultValue.
void	setDefaultValueAsString(java.lang.String item)	Sets the default value of this element.
void	setDirection(K_PARAM_DIRKIND value)	Set the value of Attribut Direction.
void	setException(boolean value)	Set the value of Attribut IsException.
void	setParameterSet(java.util.List<? extends CLParameterSet> values)	Set the value of Foreign Key ParameterSet.
void	setStream(boolean value)	Set the value of Attribut IsStream.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRowList, getTabElementRowTypeList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface de.mid.innovator.srv2api.icw2class.CLConnectAbleElement

getBindingRole, getConnectedLifeline, getConnectedLifeline, getEnd, getLifeline, getSupplierRoleBinding

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble

delete

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELMultiplicityAble

getLower, getLowerBoundAsString, getLowerUpperVal, getUpper, getUpperBoundAsString, hasMultiplicity11, hasUpper1, isMany, isMultivalued, isOptional, isOrdered, isUnique, setLower, setMany, setOptional, setOrdered, setUnique, setUpper

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELTypedElement

getModifyTypedElementDeclaration, getType, getTypedElementCnstr, getTypeKind, getValSpecOfTypedElement, getValSpecOfTypedElementWithPattern, getValSpecOfTypedElementWithPattern, isBitmapAble, isColorAble, modifyTypedElementDeclaration, setType

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

getApplicableAnalysisDia, getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Detail

getDefaultValue

java.lang.String getDefaultValue()
                          throws InoNetException,
                                 SrvErrorException

Specifies a string that represents a value to be used when no argument is supplied for the parameter.

Throws:

InoNetException

SrvErrorException

setDefaultValue

void setDefaultValue(java.lang.String value)
              throws InoNetException,
                     SrvErrorException

Set the value of Attribut DefaultValue.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getDirection

K_PARAM_DIRKIND getDirection()
                      throws InoNetException,
                             SrvErrorException

Specifies the direction kind of this parameter.

Throws:

InoNetException

SrvErrorException

setDirection

void setDirection(K_PARAM_DIRKIND value)
           throws InoNetException,
                  SrvErrorException

Set the value of Attribut Direction.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isException

boolean isException()
             throws InoNetException,
                    SrvErrorException

Informs whether an output parameter may emit a value to the exclusion of the other outputs.

Throws:

InoNetException

SrvErrorException

setException

void setException(boolean value)
           throws InoNetException,
                  SrvErrorException

Set the value of Attribut IsException.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isStream

boolean isStream()
          throws InoNetException,
                 SrvErrorException

Informs whether an input parameter may accept values while its behavior is executing or whether an output parameter post values while the behavior is executing.

Throws:

InoNetException

SrvErrorException

setStream

void setStream(boolean value)
        throws InoNetException,
               SrvErrorException

Set the value of Attribut IsStream.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

isInput

boolean isInput()
         throws InoNetException,
                SrvErrorException

Is true if the parameter provides the behavior with an input. Please take into consideration that the same parameter can qualify as input and output; this means that the number of input and output parameters may differ from the total number of parameters.

Throws:

InoNetException

SrvErrorException

isOutput

boolean isOutput()
          throws InoNetException,
                 SrvErrorException

Is true if the parameter carries an output of the behavior. Please take into consideration that the same parameter can qualify as input and output; this means that the number of input and output parameters may differ from the total number of parameters.

Throws:

InoNetException

SrvErrorException

isReturn

boolean isReturn()
          throws InoNetException,
                 SrvErrorException

True, if this parameter has the 'return' direction.

Throws:

InoNetException

SrvErrorException

isEligibleForParameterSet

boolean isEligibleForParameterSet(CLParameterSet refObj)
                           throws InoNetException,
                                  SrvErrorException

Checks for a given argument refObj if the parameter is or would be valid in this parameter CLParameterSet. This check is necessary because of the constraint that states the parameters in a parameter set must all be inputs or all be outputs.

Parameters:

refObj - A further instance of type CLParameterSet which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

getPin

<T extends ANPin> java.util.List<T> getPin(java.lang.Class<T> returnType,
                                           K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException

If the CLParameter is assigned to a BEBehavior, all pins at a ANCallBehavior invoking this BEBehavior and belonging to this CLParameter will be returned.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getPin

<T extends ANPin> java.util.List<T> getPin(java.lang.Class<T> returnType,
                                           MMStereotype stereotype,
                                           K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException

The method calls getPin and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

setDefaultValueAsString

void setDefaultValueAsString(java.lang.String item)
                      throws InoNetException,
                             SrvErrorException

Sets the default value of this element.

Parameters:

item -

Throws:

InoNetException

SrvErrorException

getActivityParameterNode

java.util.List<ACParamNode> getActivityParameterNode(K_CONTROL_OPTION... behaviourFlags)
                                              throws InoNetException,
                                                     SrvErrorException

Activity parameter is an object node at the beginning or end of flows used for accepting inputs to an activity and providing outputs from it.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getParameterSet

java.util.List<CLParameterSet> getParameterSet()
                                        throws InoNetException,
                                               SrvErrorException

All CLParameterSet this CLParameter is contained in.

Throws:

InoNetException

SrvErrorException

setParameterSet

void setParameterSet(java.util.List<? extends CLParameterSet> values)
              throws InoNetException,
                     SrvErrorException

Set the value of Foreign Key ParameterSet.

Parameters:

values - The value to be set.

Throws:

InoNetException

SrvErrorException

getOwnerFormalParam

CLBehavioralFeature getOwnerFormalParam()
                                 throws InoNetException,
                                        SrvErrorException

The behavioral feature owning this parameter.

Throws:

InoNetException

SrvErrorException

getOwningBehavior

BEBehavior getOwningBehavior()
                      throws InoNetException,
                             SrvErrorException

The behavior owning this parameter.

Throws:

InoNetException

SrvErrorException

getOwningOperation

CLOperation getOwningOperation()
                        throws InoNetException,
                               SrvErrorException

The operation owning this parameter.

Throws:

InoNetException

SrvErrorException

getOwningParameterAble

CLParameterAble getOwningParameterAble()
                                throws InoNetException,
                                       SrvErrorException

The element owning this parameter.

Throws:

InoNetException

SrvErrorException

getTypingClassifier

CLClassifier getTypingClassifier()
                          throws InoNetException,
                                 SrvErrorException

The classifier used as type for this parameter.

Throws:

InoNetException

SrvErrorException

getTypingTemplateParameterAbleClass

CLTemplateParameterAbleClass getTypingTemplateParameterAbleClass()
                                                          throws InoNetException,
                                                                 SrvErrorException

The class used as type for this parameter.

Throws:

InoNetException

SrvErrorException