Package de.mid.innovator.srv2api.icw2meta

Interface MMTextAble

All Superinterfaces:

ADFindAble, ELContainerAble, ELDeleteAble, ELElement, ELObject

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, MMProfile, MMSyncProfile, MMXProfile, 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 MMTextAble
extends ELContainerAble, ADFindAble

Elements which texts can be assigned to.

Note:

The interface MMTextAble 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	MMTextAble.VAttr

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFlowExpandedValue(MMText refObj, java.lang.String pattern)	Returns the formatted value of this element given by argument pattern or argument refObj where all fill-ins are expanded.
ARG_ModifyFlowDocumentsReq	getModifyFlowDocuments()	Returns information for the modification of flow documents of this element.
ARG_MMTextValueList	getModifyTextValues()	Compact information of all text values of this element.
ARG_ModifyTextValuesDlgInit	getModifyTextValuesDlgInit()	Fills the dialog box for the modification of text specifications of this element.
java.util.List<MMTextValue>	getOwnedTextValue(K_CONTROL_OPTION... behaviourFlags)	All text values owned by this element.
java.util.List<MMTextValue>	getOwnedTextValueByPattern(java.lang.String pattern, K_CONTROL_OPTION... behaviourFlags)	All text values owned by this element.
java.lang.String	getTextExpandedValue(MMText refObj, java.lang.String pattern)	Returns the text value of this element given by argument pattern or argument refObj where all fill-ins are expanded.
java.lang.String	getTextStringValue(MMText refObj, java.lang.String pattern)	Returns the raw text value of the current object given by argument pattern or argument refObj.
java.util.List<java.lang.String>	getURIList()	Returns the list of URI used in the text values of the current object.
void	modifyFlowDocuments(java.util.List<? extends MMText> seqText, java.util.List<java.lang.String> seqRichValue, java.util.List<java.lang.String> seqPlainValue)	Modifies the flow documents of the element by the given text-value pairs.
void	modifyTextValuesDlg(java.util.List<? extends MMText> seqText, java.util.List<java.lang.String> seqValue, java.util.List<java.lang.Boolean> seqDefault, boolean checkCnstr)	Modifies the texts of the element by the given text-value pairs.

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

Method Detail

getTextExpandedValue

java.lang.String getTextExpandedValue(MMText refObj,
                                      java.lang.String pattern)
                               throws InoNetException,
                                      SrvErrorException

Returns the text value of this element given by argument pattern or argument refObj where all fill-ins are expanded.

Parameters:

refObj - A further instance of type MMText 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

getTextStringValue

java.lang.String getTextStringValue(MMText refObj,
                                    java.lang.String pattern)
                             throws InoNetException,
                                    SrvErrorException

Returns the raw text value of the current object given by argument pattern or argument refObj.

Parameters:

refObj - A further instance of type MMText 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

getURIList

java.util.List<java.lang.String> getURIList()
                                     throws InoNetException,
                                            SrvErrorException

Returns the list of URI used in the text values of the current object.

Throws:

InoNetException

SrvErrorException

getFlowExpandedValue

java.lang.String getFlowExpandedValue(MMText refObj,
                                      java.lang.String pattern)
                               throws InoNetException,
                                      SrvErrorException

Returns the formatted value of this element given by argument pattern or argument refObj where all fill-ins are expanded.

Parameters:

refObj - A further instance of type MMText 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

getOwnedTextValueByPattern

java.util.List<MMTextValue> getOwnedTextValueByPattern(java.lang.String pattern,
                                                       K_CONTROL_OPTION... behaviourFlags)
                                                throws InoNetException,
                                                       SrvErrorException

All text values owned by this element. The list may be restricted to values with names matching argument pattern.

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

getModifyFlowDocuments

ARG_ModifyFlowDocumentsReq getModifyFlowDocuments()
                                           throws InoNetException,
                                                  SrvErrorException

Returns information for the modification of flow documents of this element.

Throws:

InoNetException

SrvErrorException

getModifyTextValuesDlgInit

ARG_ModifyTextValuesDlgInit getModifyTextValuesDlgInit()
                                                throws InoNetException,
                                                       SrvErrorException

Fills the dialog box for the modification of text specifications of this element.

Throws:

InoNetException

SrvErrorException

getModifyTextValues

ARG_MMTextValueList getModifyTextValues()
                                 throws InoNetException,
                                        SrvErrorException

Compact information of all text values of this element.

Throws:

InoNetException

SrvErrorException

modifyFlowDocuments

void modifyFlowDocuments(java.util.List<? extends MMText> seqText,
                         java.util.List<java.lang.String> seqRichValue,
                         java.util.List<java.lang.String> seqPlainValue)
                  throws InoNetException,
                         SrvErrorException

Modifies the flow documents of the element by the given text-value pairs. Be careful to set well-formed flow document format and a consistent plain text value. Otherwise you will face funny effects. If the rich text value is left empty the plain text value will be used.

Parameters:

seqText - list of text definitions

seqRichValue - FlowDocument value of the text

seqPlainValue - plain text value

Throws:

InoNetException

SrvErrorException

modifyTextValuesDlg

void modifyTextValuesDlg(java.util.List<? extends MMText> seqText,
                         java.util.List<java.lang.String> seqValue,
                         java.util.List<java.lang.Boolean> seqDefault,
                         boolean checkCnstr)
                  throws InoNetException,
                         SrvErrorException

Modifies the texts of the element by the given text-value pairs.

Parameters:

seqText - sequence of texts

seqValue - sequence of values

seqDefault - sequence of flags if the default is used

checkCnstr - isTrue, if the value constraints should be checked

Throws:

InoNetException

SrvErrorException

getOwnedTextValue

java.util.List<MMTextValue> getOwnedTextValue(K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
                                              SrvErrorException

All text values owned by this element.

Parameters:

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

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.