com.telelogic.rhapsody.core
Interface IRPAnnotation

All Superinterfaces:
IRPModelElement, IRPUnit
All Known Subinterfaces:
IRPComment, IRPConstraint, IRPRequirement

public interface IRPAnnotation
extends IRPUnit

The IRPAnnotation interface represents the different types of annotations you can add to your model - notes, comments, constraints, and requirements.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 void addAnchor(IRPModelElement target)
          Adds an anchor from the annotation to the specified model element.
 IRPCollection getAnchoredByMe()
          Gets the list of model elements that are anchored to the annotation.
 java.lang.String getBody()
          Gets the text of the specification for the annotation.
 java.lang.String getSpecification()
          Gets the text of the specification for the annotation.
 java.lang.String getSpecificationRTF()
          Returns the specification of the annotation in RTF format.
 int isSpecificationRTF()
          Checks whether the specification is in RTF format
 void removeAnchor(IRPModelElement target)
          Removes the anchor to the specified model element.
 void setBody(java.lang.String body)
          Adds a specification to the annotation.
 void setSpecification(java.lang.String specification)
          Adds a specification to the annotation.
 void setSpecificationRTF(java.lang.String specificationRTF)
          Specifies RTF string to use for the specification of the annotation.
 
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

addAnchor

void addAnchor(IRPModelElement target)
Adds an anchor from the annotation to the specified model element.

Parameters:
target - the model element the annotation should be anchored to

getAnchoredByMe

IRPCollection getAnchoredByMe()
Gets the list of model elements that are anchored to the annotation.

Returns:
the model elements that are anchored to the annotation.

getBody

java.lang.String getBody()
Gets the text of the specification for the annotation.

Returns:
the text of the specification for the annotation

getSpecification

java.lang.String getSpecification()
Gets the text of the specification for the annotation.

Returns:
the text of the specification for the annotation

getSpecificationRTF

java.lang.String getSpecificationRTF()
Returns the specification of the annotation in RTF format.

Returns:
the specification of the annotation in RTF format

isSpecificationRTF

int isSpecificationRTF()
Checks whether the specification is in RTF format

Returns:
1 if the specification is in RTF format, 0 otherwise

removeAnchor

void removeAnchor(IRPModelElement target)
Removes the anchor to the specified model element.

Parameters:
target - the model element for which the anchor should be removed

setBody

void setBody(java.lang.String body)
Adds a specification to the annotation.

Parameters:
body - the text to use as the specification

setSpecification

void setSpecification(java.lang.String specification)
Adds a specification to the annotation.

Parameters:
specification - the text to use as the specification

setSpecificationRTF

void setSpecificationRTF(java.lang.String specificationRTF)
Specifies RTF string to use for the specification of the annotation.

Parameters:
specificationRTF - the RTF string to use for the specification of the annotation