com.telelogic.rhapsody.core
Interface IRPTag

All Superinterfaces:
IRPModelElement, IRPUnit, IRPVariable

public interface IRPTag
extends IRPVariable

The IRPTag interface represents tags in a Rational Rhapsody model. To create a new tag, use the method IRPModelElement.addNewAggr.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPTag getBase()
          Returns the base tag on which the local copy of the tag is based.
 IRPProfile getFromProfile()
          For tags whose source is a profile that was added to the project (as opposed to tags defined locally in the project), this method returns the profile in which the tag was defined.
 java.lang.String getMultiplicity()
          Returns the multiplicity that was specified for the tag.
 java.lang.String getTagMetaClass()
          Returns the name of the metaclass to which the tag is applicable.
 java.lang.String getValue()
          Returns the value of the tag.
 void setMultiplicity(java.lang.String multiplicity)
          Specifies the multiplicity for the tag.
 void setTagContextValue(IRPCollection elements, IRPCollection multiplicities)
          Sets the value of the tag to a specific instance of another model element.
 void setTagMetaClass(java.lang.String tagMetaClass)
          Specifies the metaclass to which the tag should be applicable, for example, "Class".
 void setValue(java.lang.String value)
          Sets the value of the tag.
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPVariable
addElementDefaultValue, addStringDefaultValue, getDeclaration, getDefaultValue, getType, getValueSpecifications, setDeclaration, setDefaultValue, setType, setTypeDeclaration
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPUnit
copyToAnotherProject, getAddToModelMode, getCMHeader, getCMState, getCurrentDirectory, getFilename, getIncludeInNextLoad, getIsStub, getLanguage, getLastModifiedTime, getNestedSaveUnits, getNestedSaveUnitsCount, getStructureDiagrams, isReadOnly, isReferenceUnit, isSeparateSaveUnit, load, moveToAnotherProjectLeaveAReference, referenceToAnotherProject, save, setCMHeader, setFilename, setIncludeInNextLoad, setLanguage, setReadOnly, setSeparateSaveUnit, setUnitPath, unload
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPModelElement
addAssociation, addDependency, addDependencyBetween, addDependencyTo, addLinkToElement, addNewAggr, addProperty, addRedefines, addRemoteDependencyTo, addSpecificStereotype, addStereotype, becomeTemplateInstantiationOf, changeTo, clone, createOSLCLink, deleteDependency, deleteFromProject, deleteOSLCLink, errorMessage, findElementsByFullName, findNestedElement, findNestedElementRecursive, getAllTags, getAnnotations, getAssociationClasses, getBinaryID, getConstraints, getConstraintsByHim, getControlledFiles, getDecorationStyle, getDependencies, getDescription, getDescriptionHTML, getDescriptionPlainText, getDescriptionRTF, getDisplayName, getDisplayNameRTF, getErrorMessage, getFullPathName, getFullPathNameIn, getGUID, getHyperLinks, getIconFileName, getInterfaceName, getIsExternal, getIsOfMetaClass, getIsShowDisplayName, getIsUnresolved, getLocalTags, getMainDiagram, getMetaClass, getName, getNestedElements, getNestedElementsByMetaClass, getNestedElementsRecursive, getNewTermStereotype, getOfTemplate, getOSLCLinks, getOverlayIconFileName, getOverriddenProperties, getOverriddenPropertiesByPattern, getOwnedDependencies, getOwner, getProject, getPropertyValue, getPropertyValueConditional, getPropertyValueConditionalExplicit, getPropertyValueExplicit, getRedefines, getReferences, getRemoteDependencies, getRemoteURI, getRequirementTraceabilityHandle, getSaveUnit, getStereotype, getStereotypes, getTag, getTemplateParameters, getTi, getToolTipHTML, getUserDefinedMetaClass, hasNestedElements, hasPanelWidget, highLightElement, isATemplate, isDescriptionRTF, isDisplayNameRTF, isModified, isRemote, locateInBrowser, lockOnDesignManager, openFeaturesDialog, removeProperty, removeRedefines, removeStereotype, setDecorationStyle, setDescription, setDescriptionAndHyperlinks, setDescriptionHTML, setDescriptionRTF, setDisplayName, setDisplayNameRTF, setGUID, setIsShowDisplayName, setMainDiagram, setName, setOfTemplate, setOwner, setPropertyValue, setRequirementTraceabilityHandle, setStereotype, setTagContextValue, setTagElementValue, setTagValue, setTi, synchronizeTemplateInstantiation, unlockOnDesignManager
 

Method Detail

getBase

IRPTag getBase()
Returns the base tag on which the local copy of the tag is based. This method is relevant for tags that belong to stereotypes and tags that belong to profiles, but not for tags that were added locally to a specific model element.

Returns:
the base tag on which the local copy of the tag is based

getFromProfile

IRPProfile getFromProfile()
For tags whose source is a profile that was added to the project (as opposed to tags defined locally in the project), this method returns the profile in which the tag was defined.

Returns:
the profile in which the tag was defined

getMultiplicity

java.lang.String getMultiplicity()
Returns the multiplicity that was specified for the tag.

Returns:
the multiplicity that was specified for the tag

getTagMetaClass

java.lang.String getTagMetaClass()
Returns the name of the metaclass to which the tag is applicable. Relevant only for tags that belong to a profile.

Returns:
the name of the metaclass to which the tag is applicable

getValue

java.lang.String getValue()
Returns the value of the tag.

Returns:
the value of the tag

setMultiplicity

void setMultiplicity(java.lang.String multiplicity)
Specifies the multiplicity for the tag.

Parameters:
multiplicity - the multiplicity to use for the tag. You can use strings such as "1" or "14" to specify a specific number, or you can use one of the values listed in the Features dialog for tags: "0,1", "*", or "1..*".

setTagContextValue

void setTagContextValue(IRPCollection elements,
                        IRPCollection multiplicities)
Sets the value of the tag to a specific instance of another model element.

Parameters:
elements - collection of model elements representing the full path to the element. This collection is used to set the value of the tag to the full path of the target element. The collection must consist of objects of type IRPModelElement.
multiplicities - collection of the relevant indices for each of the model elements in the first collection (the "elements" parameter). This makes it possible to point to a specific instance of the target model element when multiplicity is greater than one. The collection must consist of integers provided as strings.

setTagMetaClass

void setTagMetaClass(java.lang.String tagMetaClass)
Specifies the metaclass to which the tag should be applicable, for example, "Class". Relevant only for tags that belong to a profile.

Parameters:
tagMetaClass - the metaclass to which the tag should be applicable

setValue

void setValue(java.lang.String value)
Sets the value of the tag.

Parameters:
value - the value to use for the tag