Interface MMLabelAble
- All Superinterfaces:
ADFindAble,ELContainerAble,ELDeleteAble,ELElement,ELObject,ELValueContainerAble
- All Known Subinterfaces:
ACActivity,ACActivityEdge,ACActivityFinalNode,ACActivityGroup,ACActivityNode,ACCentralBufferNode,ACControlFlow,ACControlNode,ACDataStoreNode,ACDecisionNode,ACExecutableNode,ACFinalNode,ACFlowFinalNode,ACForkNode,ACInitialNode,ACInterruptibleRegion,ACJoinNode,ACMergeNode,ACObjectFlow,ACObjectNode,ACParamNode,ACPartition,ACStructuredNode,ACVariable,ADModel,ADXModel,ANAcceptCall,ANAcceptEvent,ANAction,ANActionInputPin,ANAddStructuralFeatureValue,ANBroadcastSignal,ANCall,ANCallBehavior,ANCallOperation,ANClearAssociation,ANClearStructuralFeature,ANCreateLink,ANCreateObject,ANDestroyLink,ANDestroyObject,ANInputPin,ANInvocation,ANLink,ANOpaque,ANOutputPin,ANPin,ANRaiseException,ANReadLink,ANReadSelf,ANReadStructuralFeature,ANRemoveStructuralFeatureValue,ANReply,ANSendObject,ANSendSignal,ANStructuralFeature,ANTestIdentity,ANUnmarshall,ANValSpec,ANValuePin,ANWriteLink,ANWriteStructuralFeature,BCBaseElement,BCBaseNamedStereotypeAble,BCExpression,BCProperty,BCPropertySet,BCRelshipBinDir,BCRootReuseAbleElement,BCTerm,BEBehavior,BEChangeEvent,BEOpaque,BETimeEvent,BI2Cube,BI2CubeDimension,BI2CubeDimensionHierarchy,BI2DimensionAttribute,BI2DimensionIdAttribute,BI2DimensionLevel,BI2DimensionPrecedence,BI2DimensionShowAttribute,BI2DimensionSortAttribute,BI2DimensionTree,BI2Hierarchy,BI2HierarchyLevel,BI2MeasurementTime,BIHierarchy,BIHierarchyAttribute,BIHierarchyLevel,BIHierarchyRole,BIHierarchySortAttribute,BPActivityNode,BPActivityResource,BPArtifact,BPAssociationArtifact,BPCallAble,BPCallAbleProcessElement,BPCollaboration,BPConditionalEventDefinition,BPDataIOAssociation,BPDataObject,BPDataResource,BPDataStore,BPDia,BPEndPoint,BPError,BPEscalation,BPEventDefinition,BPEventNode,BPEventResource,BPFlowElement,BPFlowElementContainer,BPFlowProcessContainer,BPGateway,BPGatewayResource,BPGlobalMaskTask,BPGlobalTask,BPGlobalTaskResource,BPGroupArtifact,BPGroupAssign,BPInputOutputSpecifyAble,BPInputSet,BPInterface,BPItemAwareElement,BPItemDefinition,BPItemDefinitionRel,BPLane,BPLaneResource,BPLaneSet,BPLinkEventDefinition,BPLoopCharx,BPMappingAssociation,BPMaskDefinition,BPMaskField,BPMaskTask,BPMessage,BPMessageFlow,BPMessageReferencingElement,BPMultiInstLoopCharx,BPOperation,BPOutputSet,BPParticipant,BPParticipantMapping,BPPath,BPProcess,BPProcessResource,BPProperty,BPResourceRole,BPResourceRoleAble,BPSequenceFlow,BPSequenceFlowNode,BPSignal,BPStdLoopCharx,BPSubProcess,BPSupportsRel,BPTaskNode,BPTimerEventDefinition,BPUseCaseInteractionRel,BPUseCasePathRel,BRCostCenter,BRDia,BRLocation,BROrgUnit,BROrgUnitMemberRel,BROrgUnitPersonRel,BROrgUnitRequiresRole,BRPerson,BRPersonContactData,BRPersonInRole,BRResource,BRResourceCL,BRResourceHierRel,BRResourceNamedRel,BRResourceNonHierRel,BRResourceRel,BRRole,BRTechnical,BSDia,BSFinalState,BSInitState,BSPseudoState,BSRegularState,BSState,BSTransition,BSVertex,CLActor,CLArtifact,CLAssocClass,CLAssociation,CLBehavioralFeature,CLBehavioredClassifier,CLClass,CLClassDia,CLClassifier,CLClassifierTemplateParameter,CLCollaboration,CLCollaborationUse,CLCommunicationPath,CLComponent,CLComponentDia,CLComponentRealization,CLCompositeStructureDia,CLConnector,CLDataType,CLDeclarationAbleClassifier,CLDeployment,CLDeploymentDia,CLDeploymentSpec,CLDevice,CLDia,CLEncapsulatedClassifier,CLEnumeration,CLEnumLiteral,CLExecEnv,CLExtend,CLExtensionPoint,CLFeature,CLGeneralization,CLHierarchyAbleDia,CLInclude,CLInstanceSpecification,CLInstSpec,CLInterface,CLInterfaceRealization,CLManifestation,CLNode,CLOperation,CLParameter,CLParameterSet,CLPort,CLPrimitiveType,CLProperty,CLReception,CLRequirementDia,CLRoleBinding,CLSignal,CLSlot,CLStructuredClassifier,CLStructureDefinition,CLStructureDefinitionDia,CLStructureEntry,CLStructureGroup,CLSubstitution,CLTemplateBinding,CLTemplateParameter,CLTemplateParameterAbleClass,CLUseCase,CLUseCaseDia,DBAuthorization,DBAuthorizationIdentifier,DBCheckConstraint,DBColumn,DBColumnSet,DBDia,DBForeignKey,DBGroup,DBIndex,DBIndexedColumn,DBPackage,DBPrivilege,DBProcedureExpression,DBRole,DBRoleAuthorization,DBSiblingConstraint,DBSQLGeneric,DBStoredProcedure,DBTable,DBTableColumn,DBTrigger,DBUniqueKey,DBUser,DBView,DBViewColumn,DBViewFrom,DBViewSubselectFrom,DMChildExpression,DMConditional,DMContext,DMContextEntry,DMDecisionRule,DMDecisionTable,DMExpression,DMFilter,DMFunctionDefinition,DMGroup,DMInformationItem,DMInputClause,DMInvocation,DMIterator,DMList,DMLiteralExpression,DMNElement,DMOutputClause,DMRelation,DMTypedChildExpression,DRAuthorityRequirement,DRBusinessKnowledgeModel,DRDecision,DRDecisionRequirementDia,DRDecisionService,DRGElement,DRInformationRequirement,DRInputData,DRInvocable,DRKnowledgeRequirement,DRKnowledgeSource,DRRequirement,ERAttribute,ERAttributeSet,ERCheckConstraint,ERDia,ERDiaAll,EREntity,ERForeignKey,ERGeneralization,ERGeneralizationSet,ERRelationship,ERRole,ERUniqueKey,ERUsedAttribute,ERView,ERViewAttribute,ERViewFrom,ERViewSubselectFrom,GCConcept,GCConceptConnection,GCConceptRealization,GCDia,GCDynDia,GCJunction,GCNode,IAAlt,IAAssert,IABreak,IACombined,IAConsider,IACritical,IAIgnore,IAInteraction,IALifeline,IALoop,IANeg,IAOperand,IAOpt,IAPar,IASeq,IAStrict,IMAssociation,IMClassifier,IMCLDataType,IMConstraint,IMDia,IMFeature,IMForeignKeyAble,IMGeneralization,IMGeneralizationSet,IMIndex,IMIndexedFeature,IMKey,IMKeyRelationship,IMProcedure,IMProcedureExpression,IMProcedureExpressionAble,IMProperty,IMSemanticDataType,IMSequence,IMStructuralFeature,IMTrigger,IMUniqueKey,IMViewFrom,IMViewSubselectFrom,MEAbstraction,MEAssignAbleConstraint,MEConfigurationManagement,MEConstraint,MECopy,MECreateRedirect,MEDependency,MEDurationConstraint,MEElementImport,MEIntervalConstraint,MEMappingConfigurationPackage,MEMappingConfigurationPackageForward,MEMappingConfigurationPackageReverse,MEMappingDependency,MEMappingPackageContent,MEMappingPackageType,MEMappingPackageTypeForward,MEMappingPackageTypeReverse,MEModel,MEPackage,MEPackageImport,MEProxy,MEProxyAssignment,MEProxyExternal,MEProxyInnovator,MERealization,MERequirement,MESection,MESimpleConstraint,MEStubPackage,MEStubPackageBase,MEStubPackageExternalModel,MEStubPackageInnovator,MESystemModel,MESystemModelManagement,METimeConstraint,MEUsage,MMGeneral,MMLabelTextAttachmentAble,PRAnalysisDia,PRDiaWhiteboard,PRVersionAbleDia,SMChoice,SMDeepHistory,SMEntryPoint,SMExitPoint,SMFinalState,SMInit,SMJoinFork,SMJunction,SMProtocolStateMachine,SMPseudoState,SMRegion,SMRegularState,SMShallowHistory,SMState,SMStateMachine,SMTerminator,SMTransExt,SMTransInt,SMTransition,SMVertex
Elements which are allowed to own labels.
- Note:
- The interface MMLabelAble describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptiongetLabel(String pattern, K_CONTROL_OPTION... behaviourFlags) The label named argument pattern which is configured for the classification of the selected element or all labels if no pattern is given.booleangetLabelBoolValue(MMLabel refObj, String pattern) Returns the Boolean label value of the current object given by argument pattern orargument refObj.getLabelColor(String pattern) The color of the label value for this element.Label info of the current object.intgetLabelLongValue(MMLabel refObj, String pattern) Returns the long label value of the current object given by argument pattern orargument refObj.Returns a list of labels specified for this label able element.getLabelStringValue(MMLabel refObj, String pattern) Returns the label value of the current object given by argument pattern orargument refObj.<T extends ELValueReUseAble>
List<T> getLabelValueByPattern(Class<T> returnType, MMStereotype stereotype, String pattern, K_CONTROL_OPTION... behaviourFlags) The method calls getLabelValueByPattern and filters its return values according to the given stereotype value.<T extends ELValueReUseAble>
List<T> getLabelValueByPattern(Class<T> returnType, String pattern, K_CONTROL_OPTION... behaviourFlags) All label values owned by this element.getLabelValueList(boolean mode) Calculates all labels which are configured for the classification of the selected element and returns a list of multistrings each made up of label name and label value.getOwnedLabelValSpec(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) All value specifications owned by this label able element.booleanTrue, if the current object has a configured label named argument pattern.voidmodifyLabelValuesByName(List<String> seqName, List<String> seqValue, List<Boolean> seqDefault, boolean checkCnstr) Modifies the labels of the element by the given name-value pairs.voidsetLabelInfo(String value) Set the value of Info LabelInfo.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, sortContentsMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble
deleteMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement
duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getNotificationElement, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnitMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject
getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasReadMethods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble
getValueReUseAble, setValueReUseAble
-
Method Details
-
hasLabel
True, if the current object has a configured label named argument pattern.- Parameters:
pattern- A string pattern.- Throws:
InoNetExceptionSrvErrorException
-
getLabelBoolValue
Returns the Boolean label value of the current object given by argument pattern orargument refObj.- Parameters:
refObj- A further instance of type MMLabel which is used to control the behaviour of the method. (see description above) This parameter is optional. (Its value can be given as null.)pattern- A string pattern. This parameter is optional. (Its value can be given as null.)- Throws:
InoNetExceptionSrvErrorException
-
getLabelColor
The color of the label value for this element. The label must be specified by argument pattern.- Parameters:
pattern- A string pattern.- Throws:
InoNetExceptionSrvErrorException
-
getLabelInfo
Label info of the current object.- Throws:
InoNetExceptionSrvErrorException
-
setLabelInfo
Set the value of Info LabelInfo.- Parameters:
value- The value to be set.- Throws:
InoNetExceptionSrvErrorException
-
getLabelLongValue
Returns the long label value of the current object given by argument pattern orargument refObj.- Parameters:
refObj- A further instance of type MMLabel which is used to control the behaviour of the method. (see description above) This parameter is optional. (Its value can be given as null.)pattern- A string pattern. This parameter is optional. (Its value can be given as null.)- Throws:
InoNetExceptionSrvErrorException
-
getLabelStringValue
String getLabelStringValue(MMLabel refObj, String pattern) throws InoNetException, SrvErrorException Returns the label value of the current object given by argument pattern orargument refObj.- Parameters:
refObj- A further instance of type MMLabel which is used to control the behaviour of the method. (see description above) This parameter is optional. (Its value can be given as null.)pattern- A string pattern. This parameter is optional. (Its value can be given as null.)- Throws:
InoNetExceptionSrvErrorException
-
getLabelValueList
Calculates all labels which are configured for the classification of the selected element and returns a list of multistrings each made up of label name and label value. The list may be reduced by boolean argument mode to labels visible in clients and documentation.- Parameters:
mode- A value of type TBoolean that controls the behaviour of the underlying method. (see description)This parameter is optional. (Its value can be given as null.)- Throws:
InoNetExceptionSrvErrorException
-
getLabel
List<MMLabel> getLabel(String pattern, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException The label named argument pattern which is configured for the classification of the selected element or all labels if no pattern is given.- Parameters:
pattern- A string pattern. This parameter is optional. (Its value can be given as null.)behaviourFlags- An optional list of enum values to control the behaviour of the command.- Throws:
InoNetExceptionSrvErrorException
-
getLabelValueByPattern
<T extends ELValueReUseAble> List<T> getLabelValueByPattern(Class<T> returnType, String pattern, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException All label values owned by this element. The list may be restricted to values with names that match the argument pattern.- Parameters:
returnType- Specifies the type of elements to be returned.pattern- A string pattern. This parameter is optional. (Its value can be given as null.)behaviourFlags- An optional list of enum values to control the behaviour of the command.- Throws:
InoNetExceptionSrvErrorException
-
getLabelValueByPattern
<T extends ELValueReUseAble> List<T> getLabelValueByPattern(Class<T> returnType, MMStereotype stereotype, String pattern, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException The method calls getLabelValueByPattern 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 listpattern- A string pattern. This parameter is optional. (Its value can be given as null.)behaviourFlags- An optional list of enum values to control the behaviour of the command.- Throws:
InoNetExceptionSrvErrorException
-
getLabelNameValue
Returns a list of labels specified for this label able element. Each list entry contains the name and the value for a label. Labels which are not set explicitly are marked as default.- Throws:
InoNetExceptionSrvErrorException
-
modifyLabelValuesByName
void modifyLabelValuesByName(List<String> seqName, List<String> seqValue, List<Boolean> seqDefault, boolean checkCnstr) throws InoNetException, SrvErrorException Modifies the labels of the element by the given name-value pairs. Boolean values are specified by 'isTrue' and 'isFalse'.- Parameters:
seqName- name of the typed elementseqValue- value of the typed elementseqDefault- is default flag of the typed element or emptycheckCnstr- isTrue, if the value constraints should be checked- Throws:
InoNetExceptionSrvErrorException
-
getOwnedLabelValSpec
<T extends ELValSpec> List<T> getOwnedLabelValSpec(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags) throws InoNetException, SrvErrorException All value specifications owned by this label able element.- 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:
InoNetExceptionSrvErrorException- Sorted:
- the result may be sorted.
-