|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRPModelElement
The IRPModelElement interface represents an element in a Rational Rhapsody model, and its methods reflect the behavior shared by the various types of model elements. The specific types of elements in a model are derived from this interface.
Nested Class Summary | |
---|---|
static class |
IRPModelElement.OSLCLink
Constant values used with elements of this type |
Method Summary | |
---|---|
IRPAssociationClass |
addAssociation(IRPRelation end1,
IRPRelation end2,
java.lang.String name)
Creates an association class using the specified IRPRelation elements. |
IRPDependency |
addDependency(java.lang.String dependsOnName,
java.lang.String dependsOnType)
Adds a dependency from the model element to the model element specified by the parameters. |
IRPDependency |
addDependencyBetween(IRPModelElement dependent,
IRPModelElement dependsOn)
Creates a dependency between the two specified elements. |
IRPDependency |
addDependencyTo(IRPModelElement element)
Adds a dependency upon another model element. |
IRPLink |
addLinkToElement(IRPModelElement toElement,
IRPRelation assoc,
IRPModelElement fromPort,
IRPModelElement toPort)
Creates a link between this model element and the model element specified as an argument. |
IRPModelElement |
addNewAggr(java.lang.String metaType,
java.lang.String name)
Adds a new model element to the current element, for example, adding a class to a package. |
void |
addProperty(java.lang.String propertyKey,
java.lang.String propertyType,
java.lang.String propertyValue)
Adds a new property to the model element and assigns a value to it. |
void |
addRedefines(IRPModelElement newRedefine)
method addRedefines |
IRPDependency |
addRemoteDependencyTo(IRPModelElement element,
java.lang.String linkType)
For Design Manager projects, used to create a dependency from a model element to a remote element. |
void |
addSpecificStereotype(IRPStereotype stereotype)
Applies the specified stereotype to the model element. |
IRPStereotype |
addStereotype(java.lang.String name,
java.lang.String metaType)
Applies the specified stereotype to the model element if the project contains a stereotype with the name specified and applicable to the metaclass specified. |
void |
becomeTemplateInstantiationOf(IRPModelElement newVal)
Makes the current model element a template instantiation of the specified template. |
IRPModelElement |
changeTo(java.lang.String metaClass)
Changes the model element to the type of element specified by the parameter provided. |
IRPModelElement |
clone(java.lang.String name,
IRPModelElement newOwner)
Clones a model element. |
void |
createOSLCLink(java.lang.String type,
java.lang.String purl)
Creates an OSLC link between the element and the element represented by the specified URL. |
void |
deleteDependency(IRPDependency dependency)
Deletes the specified dependency from the model. |
void |
deleteFromProject()
Deletes the current model element from the model. |
void |
deleteOSLCLink(java.lang.String type,
java.lang.String purl)
Deletes the specified OSLC link from the model. |
java.lang.String |
errorMessage()
Returns error message for last method called. |
IRPModelElement |
findElementsByFullName(java.lang.String name,
java.lang.String metaClass)
Searches for the specified model element in the specified path under the current model element. |
IRPModelElement |
findNestedElement(java.lang.String name,
java.lang.String metaClass)
Searches for the specified model element. |
IRPModelElement |
findNestedElementRecursive(java.lang.String name,
java.lang.String metaClass)
Searches recursively for the specified model element. |
IRPCollection |
getAllTags()
Returns a collection of all the element's tags. |
IRPCollection |
getAnnotations()
Returns all of the element's annotations. |
IRPCollection |
getAssociationClasses()
Returns a collection of all the association classes directly beneath this model element. |
byte[] |
getBinaryID()
Returns the GUID of the model element as an array of bytes, as opposed to the method getGUID, which returns the GUID as a string. |
IRPCollection |
getConstraints()
Returns all of the element's constraints. |
IRPCollection |
getConstraintsByHim()
For internal use only. |
IRPCollection |
getControlledFiles()
Returns a collection of all the element's controlled files. |
java.lang.String |
getDecorationStyle()
Returns the name of the decoration style currently associated with the model element. |
IRPCollection |
getDependencies()
Returns all of the element's dependencies. |
java.lang.String |
getDescription()
Returns the description defined for the element. |
java.lang.String |
getDescriptionHTML()
Returns HTML representation of the element description. |
java.lang.String |
getDescriptionPlainText()
Returns the description defined for the element in plain text format. |
java.lang.String |
getDescriptionRTF()
Returns the description defined for the element in RTF format. |
java.lang.String |
getDisplayName()
Returns the label of the model element. |
java.lang.String |
getDisplayNameRTF()
Returns the label of the model element as an RTF string. |
java.lang.String |
getErrorMessage()
Returns error message for last method called. |
java.lang.String |
getFullPathName()
Returns the full path name of the model element. |
java.lang.String |
getFullPathNameIn()
Retrieves the full path name of the element as a string in the following format: (class) in (package). |
java.lang.String |
getGUID()
Returns the GUID of the model element. |
IRPCollection |
getHyperLinks()
Returns a collection of all the hyperlinks associated with the element. |
java.lang.String |
getIconFileName()
Returns the full path of the graphic file used to represent elements of this type in the browser, for example, D:\programs\rhapsody80\Share\PredefinedPictures\Icons\RhapsodyIcons_72.gif. |
java.lang.String |
getInterfaceName()
Returns the name of the API interface corresponding to the current element, for example, IRPClass for a class element, IRPOperation for an operation element. |
int |
getIsExternal()
Checks whether the element is an "external" element - corresponds to the value of the property UseAsExternal. |
int |
getIsOfMetaClass(java.lang.String metaClass)
Indicates whether the model element is based on the metaclass provided as a parameter. |
int |
getIsShowDisplayName()
Checks whether the model element is configured to have its label displayed instead of its name whenever it is included in a diagram. |
int |
getIsUnresolved()
Checks if the element is an element that can't be resolved by Rhapsody. |
IRPCollection |
getLocalTags()
Returns a collection of the tags that were created locally for this model element. |
IRPDiagram |
getMainDiagram()
Returns the "main" diagram for the element. |
java.lang.String |
getMetaClass()
Gets the name of the metaclass on which the model element is based. |
java.lang.String |
getName()
Returns the name of the element. |
IRPCollection |
getNestedElements()
Gets a collection of all the model elements that are directly under the current element. |
IRPCollection |
getNestedElementsByMetaClass(java.lang.String metaClass,
int recursive)
Retrieves all of the model elements of the specified type below the current element. |
IRPCollection |
getNestedElementsRecursive()
Returns a collection that consists of the current element and all of the model elements below it. |
IRPStereotype |
getNewTermStereotype()
If a "new term" stereotype has been applied to the element, returns the stereotype. |
IRPModelElement |
getOfTemplate()
If the element is an instantiation of a template, this method returns the template that it instantiates. |
IRPCollection |
getOSLCLinks()
Returns a collection of all the element's OSLC links. |
java.lang.String |
getOverlayIconFileName()
Returns the full path of the graphic file that is used as an overlay on this specific model element, on top of the regular icon that represent elements of this type in the browser. |
IRPCollection |
getOverriddenProperties(int recursive)
Returns a collection of all the properties whose value was overridden for this model element. |
IRPCollection |
getOverriddenPropertiesByPattern(java.lang.String pattern,
int localyOverridenOnly,
int withDefaultValues)
method getOverriddenPropertiesByPattern |
IRPCollection |
getOwnedDependencies()
Returns all of the dependencies that are owned by the element. |
IRPModelElement |
getOwner()
Returns the model element that owns this model element. |
IRPProject |
getProject()
Returns the project that the current element belongs to. |
java.lang.String |
getPropertyValue(java.lang.String propertyKey)
Returns the value of the specified property for the model element. |
java.lang.String |
getPropertyValueConditional(java.lang.String propertyKey,
IRPCollection formalKey,
IRPCollection actualValues)
Returns the value of the specified property for the model element, taking into account the collection of tokens specified and the collection of token values specified. |
java.lang.String |
getPropertyValueConditionalExplicit(java.lang.String propertyKey,
IRPCollection formalKey,
IRPCollection actualValues)
Returns the value of the specified property for the model element, if the default value was overridden, taking into account the collection of tokens specified and the collection of token values specified. |
java.lang.String |
getPropertyValueExplicit(java.lang.String propertyKey)
Returns the value of the specified property for the model element if the default value was overridden. |
IRPCollection |
getRedefines()
method getRedefines |
IRPCollection |
getReferences()
Returns a collection of all the model elements that point to this model element. |
IRPCollection |
getRemoteDependencies()
For Design Manager projects, returns a collection of all the dependencies that the model element has on remote elements. |
java.lang.String |
getRemoteURI()
For elements that are remote resources, returns the URI of the resource. |
int |
getRequirementTraceabilityHandle()
Returns the ID used by DOORS to refer to this requirement. |
IRPUnit |
getSaveUnit()
Returns the unit that the model element is saved in. |
IRPStereotype |
getStereotype()
Deprecated. Since Rhapsody now allows multiple stereotypes to be applied to a model element, the getStereotypes() method should be used instead. |
IRPCollection |
getStereotypes()
Returns a collection of the stereotypes that have been applied to the element. |
IRPTag |
getTag(java.lang.String name)
Returns the tag specified. |
IRPCollection |
getTemplateParameters()
For model elements that are templates, returns the template parameters. |
IRPTemplateInstantiation |
getTi()
For model elements that are template instantiations, returns an object that contains the template instantiation parameters. |
java.lang.String |
getToolTipHTML()
Returns the HTML that would be used to display the tooltip for the element in the user interface. |
java.lang.String |
getUserDefinedMetaClass()
Gets the name of the New Term on which the model element is based. |
int |
hasNestedElements()
Checks whether the model element contains other elements. |
int |
hasPanelWidget()
Checks whether the model element is bound to a panel diagram widget. |
void |
highLightElement()
Locates the element in the Rhapsody browser, and highlights the element in the diagram where it appears. |
int |
isATemplate()
Checks whether the model element is a template. |
int |
isDescriptionRTF()
Checks whether the description for the element is in RTF format. |
int |
isDisplayNameRTF()
Checks whether the label of the element is in RTF format. |
int |
isModified()
Checks if the element was modified since the model was last saved. |
int |
isRemote()
Checks whether the model element is a remote resource such as a DOORS/DNG requirement. |
int |
locateInBrowser()
Locates the model element in the Rhapsody browser. |
void |
lockOnDesignManager()
Locks the model element on the Design Manager server. |
void |
openFeaturesDialog(int newDialog)
Displays the information for the element in the Features window. |
void |
removeProperty(java.lang.String propertyKey)
Removes the value that was set for the specified property. |
void |
removeRedefines(IRPModelElement removedRedefine)
method removeRedefines |
void |
removeStereotype(IRPStereotype stereotype)
Removes the specified stereotype from the element. |
void |
setDecorationStyle(java.lang.String newVal)
Used to specify the decoration style that should now be associated with the model element. |
void |
setDescription(java.lang.String description)
Sets the specified string as the description of the element. |
void |
setDescriptionAndHyperlinks(java.lang.String rtfText,
IRPCollection targets)
Specifies an RTF string to use as the description for the element, and a collection of elements to which hyperlinks should be created. |
void |
setDescriptionHTML(java.lang.String descriptionHTML)
Specifies the HTML text to use for the description of the model element. |
void |
setDescriptionRTF(java.lang.String descriptionRTF)
Specifies the RTF string to use for the description of the model element. |
void |
setDisplayName(java.lang.String displayName)
Specifies the text to use for the label of the model element. |
void |
setDisplayNameRTF(java.lang.String newVal)
Specifies the RTF string to use for the label of the model element. |
void |
setGUID(java.lang.String gUID)
Sets a new GUID for the model element. |
void |
setIsShowDisplayName(int isShowDisplayName)
Specifies whether the label of the element should be displayed instead of the element name whenever the element is used in a diagram. |
void |
setMainDiagram(IRPDiagram mainDiagram)
Specifies the "main" diagram for the element. |
void |
setName(java.lang.String name)
Sets the specified string as the name of the element. |
void |
setOfTemplate(IRPModelElement ofTemplate)
Makes the current model element a template instantiation of the specified template. |
void |
setOwner(IRPModelElement owner)
Specifies the model element that should be the owner of this element. |
void |
setPropertyValue(java.lang.String propertyKey,
java.lang.String propertyValue)
Sets the value of a property for the model element. |
void |
setRequirementTraceabilityHandle(int requirementTraceabilityHandle)
Sets a new ID to be used to reference this requirement |
void |
setStereotype(IRPStereotype stereotype)
Applies the specified stereotype to the element. |
IRPTag |
setTagContextValue(IRPTag tag,
IRPCollection elements,
IRPCollection multiplicities)
Applies the specified tag to the model element, and sets the value of the tag to a specific instance of another model element. |
IRPTag |
setTagElementValue(IRPTag tag,
IRPModelElement val)
Applies a tag whose type is a model element to the current element with the value specified. |
IRPTag |
setTagValue(IRPTag tag,
java.lang.String val)
Applies the specified tag to the model element with the value specified. |
void |
setTi(IRPTemplateInstantiation ti)
For internal use only. |
void |
synchronizeTemplateInstantiation()
After changes are made to a template, this method can be called on each instantiation of the template in order to update the instantiation to match the changes that were made to the template. |
void |
unlockOnDesignManager()
Unlocks the model element on the Design Manager server. |
Method Detail |
---|
IRPAssociationClass addAssociation(IRPRelation end1, IRPRelation end2, java.lang.String name)
end1
- the IRPRelation element at one end of the associationend2
- the IRPRelation element at the second end of the associationname
- the name to use for the new association class
IRPDependency addDependency(java.lang.String dependsOnName, java.lang.String dependsOnType)
dependsOnName
- the name of the model element on which this model element dependsdependsOnType
- the type (metaclass) of the model element on which this model element depends. The strings to use for this parameter should be taken from the file metaclasses.txt in the Doc directory of the Rhapsody installation.
IRPDependency addDependencyBetween(IRPModelElement dependent, IRPModelElement dependsOn)
dependent
- the model element that is dependent on the other model elementdependsOn
- the model element that the first element depends upon
RhapsodyRuntimeException
IRPDependency addDependencyTo(IRPModelElement element)
element
- the model element that this element depends upon
IRPLink addLinkToElement(IRPModelElement toElement, IRPRelation assoc, IRPModelElement fromPort, IRPModelElement toPort)
toElement
- the model element that the link should connect toassoc
- the association that the link should representfromPort
- the "from" port for the linktoPort
- the "to" port for the link
IRPModelElement addNewAggr(java.lang.String metaType, java.lang.String name)
metaType
- the type of element to add. The string to use is the name of the appropriate metaclass. The list of metaclass names that can be used for this argument can be found in the file metaclasses.txt in the Doc directory of your Rhapsody installation.name
- the name to use for the new element
static IRPApplication app = RhapsodyAppServer.getActiveRhapsodyApplication();
IRPProject prj = app.openProject("d:\\temp\\_sample_code\\Class_Tricks.rpy");
IRPPackage cameraPackage = prj.addPackage("Cameras");
cameraPackage.addNewAggr("Stereotype", "s1");
void addProperty(java.lang.String propertyKey, java.lang.String propertyType, java.lang.String propertyValue)
propertyKey
- the name of the property to add. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.NewPropertypropertyType
- the property type. The strings that can be used for this parameter are: "Enum","Bool","String","Color","Int","Double","Font","File","Path", and "MultiLine". If you want to add a property of type Enum, you can specify the possible values using the following syntax for this parameter: "Enum,wood,plastic,metal".propertyValue
- the value to assign to the new property. For boolean properties, use "True" or "False".void addRedefines(IRPModelElement newRedefine)
RhapsodyRuntimeException
IRPDependency addRemoteDependencyTo(IRPModelElement element, java.lang.String linkType)
element
- the remote element to which a dependency should be createdlinkType
- - one of the link types available with the requirement tool that you are using. For example, for Doors Next Generation, the possible types are "Derives From", "Refines", "Satisfies", and "Trace".
void addSpecificStereotype(IRPStereotype stereotype)
stereotype
- the stereotype to apply to the model elementIRPStereotype addStereotype(java.lang.String name, java.lang.String metaType)
name
- the name of the stereotype to apply (or create and apply)metaType
- the metaclass that the stereotype is applicable to
void becomeTemplateInstantiationOf(IRPModelElement newVal)
newVal
- the template to use for the instantiationIRPModelElement changeTo(java.lang.String metaClass)
metaClass
- the metaclass of the element that this element should be changed to. The strings to use for this parameter should be taken from the file metaclasses.txt in the Doc directory of the Rhapsody installation.
IRPModelElement clone(java.lang.String name, IRPModelElement newOwner)
name
- the name to use for the new elementnewOwner
- the model element that should be the owner of the new element
void createOSLCLink(java.lang.String type, java.lang.String purl)
type
- one of the OSLC link types that can be created. Must be one of the typed defined in IRPModelElement.OSLCLink.Types. Note that the "Derives From" link type can only be used when creating a link to a requirement from DNG.purl
- the URL for the target element
RhapsodyRuntimeException
void deleteDependency(IRPDependency dependency)
dependency
- the dependency to be deletedvoid deleteFromProject()
void deleteOSLCLink(java.lang.String type, java.lang.String purl)
type
- the link type of the OSLC link that is to be deleted. Must be one of the typed defined in IRPModelElement.OSLCLink.Types
. You can also use "*" to represent all of the types.purl
- the URL for the link's target element. You can use "*" as the value of the parameter in order to delete all links of the specified type.
RhapsodyRuntimeException
java.lang.String errorMessage()
IRPModelElement findElementsByFullName(java.lang.String name, java.lang.String metaClass)
// this code gets the class Webcam in the package SpecializedCameras which is a subpackage of the top-level package Cameras IRPProject currentProject = app.activeProject(); IRPClass classToFind = (IRPClass)currentProject.findElementsByFullName("Webcam in Cameras::SpecializedCameras", "Class"); System.out.println(classToFind.getFullPathName());
name
- the name of the element to search for and the relative path to the element starting at the current element. This argument can use the format "Class in Package::Subpackage" or the format "Package::Subpackage::Class", for example, findElementsByFullName("Cameras::SpecializedCameras::Webcam", "Class")metaClass
- the metaclass of the element you are looking for. The strings to use for this parameter should be taken from the file metaclasses.txt in the Doc directory of the Rhapsody installation.
IRPModelElement findNestedElement(java.lang.String name, java.lang.String metaClass)
name
- the name of the element to search formetaClass
- the metaclass of the element you are looking for. The strings to use for this parameter should be taken from the file metaclasses.txt in the Doc directory of the Rhapsody installation.
IRPModelElement findNestedElementRecursive(java.lang.String name, java.lang.String metaClass)
name
- the name of the element to search formetaClass
- the metaclass of the element you are looking for. The strings to use for this parameter should be taken from the file metaclasses.txt in the Doc directory of the Rhapsody installation.
IRPCollection getAllTags()
IRPCollection getAnnotations()
IRPCollection getAssociationClasses()
byte[] getBinaryID()
IRPCollection getConstraints()
IRPCollection getConstraintsByHim()
IRPCollection getControlledFiles()
java.lang.String getDecorationStyle()
IRPCollection getDependencies()
java.lang.String getDescription()
java.lang.String getDescriptionHTML()
java.lang.String getDescriptionPlainText()
java.lang.String getDescriptionRTF()
java.lang.String getDisplayName()
java.lang.String getDisplayNameRTF()
java.lang.String getErrorMessage()
java.lang.String getFullPathName()
// this code prints the full path name for each class in the Cameras package, including the classes in subpackages System.out.println("======================================================================"); IRPCollection allClassesInCamerasPackage = cameraPackage.getNestedElementsByMetaClass("Class", 1); int numberOfClasses = allClassesInCamerasPackage.getCount(); // note that when using getItem to get an item from an IRPCollection object, the index starts at 1, not 0 IRPModelElement elementInCollection; for(int i = 1; i < numberOfClasses+1 ; i++) { elementInCollection = (IRPModelElement)allClassesInCamerasPackage.getItem(i); System.out.println(elementInCollection.getFullPathName()); }
java.lang.String getFullPathNameIn()
java.lang.String getGUID()
IRPCollection getHyperLinks()
java.lang.String getIconFileName()
java.lang.String getInterfaceName()
int getIsExternal()
int getIsOfMetaClass(java.lang.String metaClass)
metaClass
- The name of the metaclass to check for. The strings to use for this parameter should be taken from the file metaclasses.txt in the Doc directory of the Rhapsody installation.
int getIsShowDisplayName()
int getIsUnresolved()
IRPCollection getLocalTags()
IRPDiagram getMainDiagram()
java.lang.String getMetaClass()
java.lang.String getName()
IRPCollection getNestedElements()
IRPProject prj = app.openProject("l:\\temp\\_sample_code\\Unit_Tricks.rpy");
IRPPackage vehiclePackage = prj.addPackage("Vehicles");
vehiclePackage.addClass("Car");
vehiclePackage.addClass("Jeep");
vehiclePackage.addClass("Convertible");
prj.save();
IRPCollection elementsInVehiclesPackage = vehiclePackage.getNestedElements();
IRPModelElement elementInCollection;
System.out.println("The Vehicles package contains:");
for (int i = 1; i <= elementsInVehiclesPackage.getCount(); i++) {
elementInCollection = (IRPModelElement)elementsInVehiclesPackage.getItem(i);
System.out.println("\t" + elementInCollection.getName());
}
IRPCollection getNestedElementsByMetaClass(java.lang.String metaClass, int recursive)
// this code retrieves all the classes in the Cameras package (including classes in subpackages), and prints their type and name IRPCollection allClassesInCamerasPackage = cameraPackage.getNestedElementsByMetaClass("Class", 1); int numberOfClasses = allClassesInCamerasPackage.getCount(); // note that when using getItem to get an item from an IRPCollection object, the index starts at 1, not 0 IRPModelElement elementInCollection; for(int i = 1; i < numberOfClasses+1 ; i++) { elementInCollection = (IRPModelElement)allClassesInCamerasPackage.getItem(i); System.out.println(elementInCollection.getMetaClass() + ": " + elementInCollection.getDisplayName()); }
metaClass
- the type of elements that you want to retrieve. The strings to use for this parameter should be taken from the file metaclasses.txt in the Doc directory of the Rhapsody installation.recursive
- Use 1 to specify that the retrieval should be recursive. Use 0 if you only want to retrieve the relevant elements from the first level below the current element.
IRPCollection getNestedElementsRecursive()
// this code retrieves all the items in the Cameras package, and prints their type and name IRPCollection allItemsInCameraPackage = cameraPackage.getNestedElementsRecursive(); int numberOfElements = allItemsInCameraPackage.getCount(); // note that when using getItem to get an item from an IRPCollection object, the index starts at 1, not 0 IRPModelElement elementInCollection; for(int i = 1; i < numberOfElements+1 ; i++) { elementInCollection = (IRPModelElement)allItemsInCameraPackage.getItem(i); System.out.println(elementInCollection.getMetaClass() + ": " + elementInCollection.getDisplayName()); }
IRPStereotype getNewTermStereotype()
IRPCollection getOSLCLinks()
RhapsodyRuntimeException
IRPModelElement getOfTemplate()
java.lang.String getOverlayIconFileName()
IRPCollection getOverriddenProperties(int recursive)
recursive
- use 1 to specify that the method should return all properties overridden for the element - from the level of the element itself all the way up to the project level, use 0 to specify that the method should only return the properties that were overridden at the level of the element itself
IRPCollection getOverriddenPropertiesByPattern(java.lang.String pattern, int localyOverridenOnly, int withDefaultValues)
RhapsodyRuntimeException
IRPCollection getOwnedDependencies()
RhapsodyRuntimeException
IRPModelElement getOwner()
IRPProject getProject()
java.lang.String getPropertyValue(java.lang.String propertyKey)
propertyKey
- the property whose value should be returned. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadName
java.lang.String getPropertyValueConditional(java.lang.String propertyKey, IRPCollection formalKey, IRPCollection actualValues)
propertyKey
- the property whose value should be returned. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadNameformalKey
- the collection of tokens to take into account (collection of strings)actualValues
- the collection of token values to take into account (collection of strings)
java.lang.String getPropertyValueConditionalExplicit(java.lang.String propertyKey, IRPCollection formalKey, IRPCollection actualValues)
propertyKey
- the property whose value should be returned. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadNameformalKey
- the collection of tokens to take into account (collection of strings)actualValues
- the collection of token values to take into account (collection of strings)
java.lang.String getPropertyValueExplicit(java.lang.String propertyKey)
propertyKey
- the property whose value should be returned. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadName
IRPCollection getRedefines()
RhapsodyRuntimeException
IRPCollection getReferences()
IRPCollection getRemoteDependencies()
java.lang.String getRemoteURI()
int getRequirementTraceabilityHandle()
IRPUnit getSaveUnit()
IRPStereotype getStereotype()
IRPCollection getStereotypes()
IRPTag getTag(java.lang.String name)
name
- the name of the tag to return
IRPCollection getTemplateParameters()
IRPTemplateInstantiation getTi()
java.lang.String getToolTipHTML()
java.lang.String getUserDefinedMetaClass()
int hasNestedElements()
int hasPanelWidget()
void highLightElement()
int isATemplate()
int isDescriptionRTF()
int isDisplayNameRTF()
int isModified()
int isRemote()
int locateInBrowser()
void lockOnDesignManager()
void openFeaturesDialog(int newDialog)
newDialog
- Use 1 to specify that the element information should be displayed in a new Features window. Use 0 to specify that the information should be displayed in a Features window that is already open or in a new window if there is no open Features window.void removeProperty(java.lang.String propertyKey)
propertyKey
- the property whose value should be removed. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadNamevoid removeRedefines(IRPModelElement removedRedefine)
RhapsodyRuntimeException
void removeStereotype(IRPStereotype stereotype)
stereotype
- the stereotype to be removed from the elementvoid setDecorationStyle(java.lang.String newVal)
newVal
- The decoration style that should now be associated with the model element. The value of the parameter must be one of the strings included in the value of the property Format::Decoration::StyleNames.void setDescription(java.lang.String description)
description
- the string to use as the description of the elementvoid setDescriptionAndHyperlinks(java.lang.String rtfText, IRPCollection targets)
rtfText
- the string to use for the element description - must be in RTF formattargets
- the collection of elements for which hyperlinks should be createdvoid setDescriptionHTML(java.lang.String descriptionHTML)
descriptionHTML
- the HTML text to use for the description of the model elementvoid setDescriptionRTF(java.lang.String descriptionRTF)
descriptionRTF
- the RTF string to use for the description of the model elementvoid setDisplayName(java.lang.String displayName)
displayName
- the text to use for the label of the model elementvoid setDisplayNameRTF(java.lang.String newVal)
newVal
- the RTF string to use for the label of the model elementvoid setGUID(java.lang.String gUID)
gUID
- the new GUID that should be used for the model elementvoid setIsShowDisplayName(int isShowDisplayName)
isShowDisplayName
- use 1 if you want the label of the element displayed, use 0 if you want the name of the element displayedvoid setMainDiagram(IRPDiagram mainDiagram)
mainDiagram
- the diagram to use as the "main" diagram for the elementvoid setName(java.lang.String name)
name
- the string to use as the name of the elementvoid setOfTemplate(IRPModelElement ofTemplate)
ofTemplate
- the template to use for the instantiationvoid setOwner(IRPModelElement owner)
owner
- the model element that should be the owner of this elementvoid setPropertyValue(java.lang.String propertyKey, java.lang.String propertyValue)
propertyKey
- the property whose value should be set. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadName.propertyValue
- the new value to use for the property. For boolean properties, use "True" or "False".void setRequirementTraceabilityHandle(int requirementTraceabilityHandle)
requirementTraceabilityHandle
- the new ID that should be used to reference this requirementvoid setStereotype(IRPStereotype stereotype)
stereotype
- the stereotype to be applied to the elementIRPTag setTagContextValue(IRPTag tag, IRPCollection elements, IRPCollection multiplicities)
tag
- the tag to apply to the model elementelements
- 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.
IRPTag setTagElementValue(IRPTag tag, IRPModelElement val)
tag
- the tag to apply to the elementval
- the value to use for the tag applied
IRPTag setTagValue(IRPTag tag, java.lang.String val)
tag
- the tag to apply to the elementval
- the value to use for the tag applied
void setTi(IRPTemplateInstantiation ti)
void synchronizeTemplateInstantiation()
void unlockOnDesignManager()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |