Package de.mid.innovator.srv2api.icw2meta

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, BPCallAbleChoreographyElement, BPCallAbleProcessElement, BPChoreography, BPChoreographyActivity, BPChoreographySubProcess, BPChoreographyTask, BPCollaboration, BPConditionalEventDefinition, BPDataIOAssociation, BPDataObject, BPDataStore, BPDia, BPEndPoint, BPError, BPEscalation, BPEventDefinition, BPEventNode, BPFlowChoreographyContainer, BPFlowElement, BPFlowElementContainer, BPFlowProcessContainer, BPGateway, BPGlobalChoreographyTask, BPGlobalMaskTask, BPGlobalTask, BPGlobalTaskResource, BPGroupArtifact, BPGroupAssign, BPInputSet, BPInterface, BPItemAwareElement, BPItemDefinition, BPItemDefinitionRel, BPLane, BPLaneSet, BPLinkEventDefinition, BPLoopCharx, BPMappingAssociation, BPMaskDefinition, BPMaskField, BPMaskTask, BPMessage, BPMessageFlow, BPMessageFlowMapping, BPMessageReferencingElement, BPMultiInstLoopCharx, BPOperation, BPOutputSet, BPParticipant, BPParticipantMapping, BPPath, BPProcess, BPProperty, 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, DMContext, DMContextEntry, DMDecisionRule, DMDecisionTable, DMExpression, DMFunctionDefinition, DMInformationItem, DMInputClause, DMInvocation, DMList, DMLiteralExpression, DMNElement, DMOutputClause, DMRelation, 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, 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

public interface MMLabelAble
extends ELContainerAble, ADFindAble, ELValueContainerAble

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

Modifier and Type	Interface	Description
static class	MMLabelAble.VAttr

Method Summary

Modifier and Type	Method	Description
java.util.List<MMLabel>	getLabel(java.lang.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.
boolean	getLabelBoolValue(MMLabel refObj, java.lang.String pattern)	Returns the Boolean label value of the current object given by argument pattern or argument refObj.
java.lang.String	getLabelColor(java.lang.String pattern)	The color of the label value for this element.
java.lang.String	getLabelInfo()	Label info of the current object.
int	getLabelLongValue(MMLabel refObj, java.lang.String pattern)	Returns the long label value of the current object given by argument pattern or argument refObj.
java.util.List<ARG_NameValueDefault>	getLabelNameValue()	Returns a list of labels specified for this label able element.
java.lang.String	getLabelStringValue(MMLabel refObj, java.lang.String pattern)	Returns the label value of the current object given by argument pattern or argument refObj.
<T extends ELValueReUseAble> java.util.List<T>	getLabelValueByPattern(java.lang.Class<T> returnType, MMStereotype stereotype, java.lang.String pattern, K_CONTROL_OPTION... behaviourFlags)	The method calls getLabelValueByPattern and filters its return values according to the given stereotype value.
<T extends ELValueReUseAble> java.util.List<T>	getLabelValueByPattern(java.lang.Class<T> returnType, java.lang.String pattern, K_CONTROL_OPTION... behaviourFlags)	All label values owned by this element.
java.util.List<java.lang.String>	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.
<T extends ELValSpec> java.util.List<T>	getOwnedLabelValSpec(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All value specifications owned by this label able element.
boolean	hasLabel(java.lang.String pattern)	True, if the current object has a configured label named argument pattern.
void	modifyLabelValuesByName(java.util.List<java.lang.String> seqName, java.util.List<java.lang.String> seqValue, java.util.List<java.lang.Boolean> seqDefault, boolean checkCnstr)	Modifies the labels of the element by the given name-value pairs.
void	setLabelInfo(java.lang.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, sortContents

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.ELObject

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

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

getValueReUseAble, setValueReUseAble

Method Detail

hasLabel

boolean hasLabel(java.lang.String pattern)
          throws InoNetException,
                 SrvErrorException

True, if the current object has a configured label named argument pattern.

Parameters:

pattern - A string pattern.

Throws:

InoNetException

SrvErrorException

getLabelBoolValue

boolean getLabelBoolValue(MMLabel refObj,
                          java.lang.String pattern)
                   throws InoNetException,
                          SrvErrorException

Returns the Boolean label value of the current object given by argument pattern or argument 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:

InoNetException

SrvErrorException

getLabelColor

java.lang.String getLabelColor(java.lang.String pattern)
                        throws InoNetException,
                               SrvErrorException

The color of the label value for this element. The label must be specified by argument pattern.

Parameters:

pattern - A string pattern.

Throws:

InoNetException

SrvErrorException

getLabelInfo

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

Label info of the current object.

Throws:

InoNetException

SrvErrorException

setLabelInfo

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

Set the value of Info LabelInfo.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getLabelLongValue

int getLabelLongValue(MMLabel refObj,
                      java.lang.String pattern)
               throws InoNetException,
                      SrvErrorException

Returns the long label value of the current object given by argument pattern or argument 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:

InoNetException

SrvErrorException

getLabelStringValue

java.lang.String getLabelStringValue(MMLabel refObj,
                                     java.lang.String pattern)
                              throws InoNetException,
                                     SrvErrorException

Returns the label value of the current object given by argument pattern or argument 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:

InoNetException

SrvErrorException

getLabelValueList

java.util.List<java.lang.String> getLabelValueList(boolean mode)
                                            throws InoNetException,
                                                   SrvErrorException

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:

InoNetException

SrvErrorException

getLabel

java.util.List<MMLabel> getLabel(java.lang.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:

InoNetException

SrvErrorException

getLabelValueByPattern

<T extends ELValueReUseAble> java.util.List<T> getLabelValueByPattern(java.lang.Class<T> returnType,
                                                                      java.lang.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:

InoNetException

SrvErrorException

getLabelValueByPattern

<T extends ELValueReUseAble> java.util.List<T> getLabelValueByPattern(java.lang.Class<T> returnType,
                                                                      MMStereotype stereotype,
                                                                      java.lang.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 list

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:

InoNetException

SrvErrorException

getLabelNameValue

java.util.List<ARG_NameValueDefault> getLabelNameValue()
                                                throws InoNetException,
                                                       SrvErrorException

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:

InoNetException

SrvErrorException

modifyLabelValuesByName

void modifyLabelValuesByName(java.util.List<java.lang.String> seqName,
                             java.util.List<java.lang.String> seqValue,
                             java.util.List<java.lang.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 element

seqValue - value of the typed element

seqDefault - is default flag of the typed element or empty

checkCnstr - isTrue, if the value constraints should be checked

Throws:

InoNetException

SrvErrorException

getOwnedLabelValSpec

<T extends ELValSpec> java.util.List<T> getOwnedLabelValSpec(java.lang.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:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.