com.telelogic.rhapsody.core
Interface IRPStereotype

All Superinterfaces:
IRPClassifier, IRPModelElement, IRPUnit

public interface IRPStereotype
extends IRPClassifier

The IRPStereotype interface represents sterotypes in Rational Rhapsody models.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 void addMetaClass(java.lang.String metaClass)
          Adds a metaclass to the list of metaclasses that the stereotype can be applied to.
 java.lang.String getIcon()
          Gets the full path for the image file that is associated with this stereotype.
 int getIsNewTerm()
          Checks whether the stereotype is a "new term" stereotype.
 java.lang.String getOfMetaClass()
          Gets the names of the metaclasses that the stereotype can be applied to.
 void removeMetaClass(java.lang.String metaClass)
          Removes a metaclass from the list of metaclasses that the stereotype can be applied to.
 void setIsNewTerm(int isNewTerm)
          Used to change a stereotype to a "new term" stereotype, or change a "new term" stereotype to an ordinary stereotype.
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPClassifier
addActivityDiagram, addAttribute, addFlowItems, addFlows, addGeneralization, addOperation, addRelation, addRelationTo, addStatechart, addUnidirectionalRelation, addUnidirectionalRelationTo, deleteAttribute, deleteFlowItems, deleteFlows, deleteGeneralization, deleteOperation, deleteRelation, findAttribute, findBaseClassifier, findDerivedClassifier, findGeneralization, findInterfaceItem, findNestedClassifier, findNestedClassifierRecursive, findRelation, findTrigger, getActivityDiagram, getAttributes, getAttributesIncludingBases, getBaseClassifiers, getBehavioralDiagrams, getDerivedClassifiers, getFlowItems, getFlows, getGeneralizations, getInterfaceItems, getInterfaceItemsIncludingBases, getLinks, getNestedClassifiers, getOperations, getPorts, getRelations, getRelationsIncludingBases, getSequenceDiagrams, getSourceArtifacts, getStatechart
 
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

addMetaClass

void addMetaClass(java.lang.String metaClass)
Adds a metaclass to the list of metaclasses that the stereotype can be applied to.

Parameters:
metaClass - the metaclass to add. Note that this string parameter can only contain the name of one metaclass. Adding multiple metaclasses requires multiple calls of this method.

getIcon

java.lang.String getIcon()
Gets the full path for the image file that is associated with this stereotype.

Returns:
the full path for the image file that is associated with this stereotype

getIsNewTerm

int getIsNewTerm()
Checks whether the stereotype is a "new term" stereotype. For more information about "new terms", see the help for customizing Rhapsody.

Returns:
indication of whether the stereotype is a "new term". 1 means that the stereotype is a "new term", 0 means that the stereotype is not a "new term".

getOfMetaClass

java.lang.String getOfMetaClass()
Gets the names of the metaclasses that the stereotype can be applied to.

Returns:
the names of the metaclasses that the stereotype can be applied to. If there is more than one such metaclass, the string returned will consist of a comma-separated list of the names.

removeMetaClass

void removeMetaClass(java.lang.String metaClass)
Removes a metaclass from the list of metaclasses that the stereotype can be applied to.

Parameters:
metaClass - the metaclass to remove. Note that this string parameter can only contain the name of one metaclass. Removing multiple metaclasses requires multiple calls of this method.

setIsNewTerm

void setIsNewTerm(int isNewTerm)
Used to change a stereotype to a "new term" stereotype, or change a "new term" stereotype to an ordinary stereotype. For more information about "new terms", see the help for customizing Rhapsody.

Parameters:
isNewTerm - Use 1 to change the stereotype to a "new term" stereotype. Use 0 to change a "new term" stereotype to an ordinary stereotype.