com.telelogic.rhapsody.core
Interface IRPModelElement

All Known Subinterfaces:
IRPAcceptEventAction, IRPAcceptTimeEvent, IRPAction, IRPActionBlock, IRPActivityDiagram, IRPActor, IRPAnnotation, IRPArgument, IRPAssociationClass, IRPAssociationRole, IRPAttribute, IRPCallOperation, IRPClass, IRPClassifier, IRPClassifierRole, IRPCollaboration, IRPCollaborationDiagram, IRPComment, IRPComponent, IRPComponentDiagram, IRPComponentInstance, IRPConditionMark, IRPConfiguration, IRPConnector, IRPConstraint, IRPContextSpecification, IRPControlledFile, IRPDependency, IRPDeploymentDiagram, IRPDestructionEvent, IRPDiagram, IRPEnumerationLiteral, IRPEvent, IRPEventReception, IRPExecutionOccurrence, IRPFile, IRPFileFragment, IRPFlow, IRPFlowchart, IRPFlowItem, IRPGeneralization, IRPGuard, IRPHyperLink, IRPInstance, IRPInstanceSlot, IRPInstanceSpecification, IRPInstanceValue, IRPInteractionOccurrence, IRPInteractionOperand, IRPInteractionOperator, IRPInterfaceItem, IRPLink, IRPLiteralSpecification, IRPMatrixLayout, IRPMatrixView, IRPMessage, IRPMessagePoint, IRPModule, IRPNode, IRPObjectModelDiagram, IRPObjectNode, IRPOperation, IRPPackage, IRPPanelDiagram, IRPPin, IRPPort, IRPProfile, IRPProject, IRPRelation, IRPRequirement, IRPSendAction, IRPSequenceDiagram, IRPState, IRPStatechart, IRPStatechartDiagram, IRPStateVertex, IRPStereotype, IRPStructureDiagram, IRPSwimlane, IRPSysMLPort, IRPTableLayout, IRPTableView, IRPTag, IRPTemplateInstantiation, IRPTemplateInstantiationParameter, IRPTemplateParameter, IRPTimingDiagram, IRPTransition, IRPTrigger, IRPType, IRPUnit, IRPUseCase, IRPUseCaseDiagram, IRPValueSpecification, IRPVariable

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

addAssociation

IRPAssociationClass addAssociation(IRPRelation end1,
                                   IRPRelation end2,
                                   java.lang.String name)
Creates an association class using the specified IRPRelation elements. Can only be called on the elements that can contain association classes - packages and classes. To add an ordinary association, use the method IRPClassifier.addRelationTo.

Parameters:
end1 - the IRPRelation element at one end of the association
end2 - the IRPRelation element at the second end of the association
name - the name to use for the new association class
Returns:
the association class that was created

addDependency

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. The method searches the model recursively until it finds an element that matches the name and metaclass specified. Since your model may contain multiple elements with the same name and type in different packages, the preferred way to add a dependency is to use the method addDependencyTo, which takes a specific model element as an argument.

Parameters:
dependsOnName - the name of the model element on which this model element depends
dependsOnType - 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.
Returns:
the new dependency that was created

addDependencyBetween

IRPDependency addDependencyBetween(IRPModelElement dependent,
                                   IRPModelElement dependsOn)
Creates a dependency between the two specified elements. In most cases, you can use the method IRPModelElement.addDependencyTo to add a new dependency. However, in cases where you want to create a dependency between two read-only elements, you can use addDependencyBetween to create the new dependency and assign ownership of the dependency to a third model element.

Parameters:
dependent - the model element that is dependent on the other model element
dependsOn - the model element that the first element depends upon
Returns:
the new dependency that was created
Throws:
RhapsodyRuntimeException

addDependencyTo

IRPDependency addDependencyTo(IRPModelElement element)
Adds a dependency upon another model element.

Parameters:
element - the model element that this element depends upon
Returns:
the dependency created

addLinkToElement

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. The types of elements that can be connected with a link by using this method are the same types of elements that can be joined by a link in the Rational Rhapsody diagram editors. In addition to specifying the other model element that should be connected by this link, you must specify the association that the link should represent, or, alternatively, the two ports that should be used for the link. If you provide the two ports as arguments, you should use Null for the association argument. Similarly, if you specify an association, you should use Null for the two port arguments. Note that if you are not specifying the two ports, you must provide an association as an argument even if there is only one relevant association.

Parameters:
toElement - the model element that the link should connect to
assoc - the association that the link should represent
fromPort - the "from" port for the link
toPort - the "to" port for the link
Returns:
the link created

addNewAggr

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.

Parameters:
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
Returns:
the new element that was created
 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");
 
 

addProperty

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. Note that this method does not have a user interface equivalent in the Features window.

Parameters:
propertyKey - the name of the property to add. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.NewProperty
propertyType - 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".

addRedefines

void addRedefines(IRPModelElement newRedefine)
method addRedefines

Throws:
RhapsodyRuntimeException

addRemoteDependencyTo

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. This method corresponds to the "link to remote requirement" option in the user interface. In order to have the remote element available as a model element to use with this method, you must first call the IRPProject.getRemoteResourcePackages() method. (For remote requirements that are not yet linked to any elements in the model, you must also call the IRPPackage.populateRemoteRequirements() method.) Note that while the first parameter can be any object of type IRPModelElement, at the moment you can only add dependencies to remote requirements.

Parameters:
element - the remote element to which a dependency should be created
linkType - - 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".
Returns:
the new dependency that was created

addSpecificStereotype

void addSpecificStereotype(IRPStereotype stereotype)
Applies the specified stereotype to the model element.

Parameters:
stereotype - the stereotype to apply to the model element

addStereotype

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. If the project does not yet contain such a stereotype, this method creates the stereotype in the package that owns the model element, and applies the new stereotype to the model element.

Parameters:
name - the name of the stereotype to apply (or create and apply)
metaType - the metaclass that the stereotype is applicable to
Returns:
the stereotype applied (or created and applied) to the model element

becomeTemplateInstantiationOf

void becomeTemplateInstantiationOf(IRPModelElement newVal)
Makes the current model element a template instantiation of the specified template.

Parameters:
newVal - the template to use for the instantiation

changeTo

IRPModelElement changeTo(java.lang.String metaClass)
Changes the model element to the type of element specified by the parameter provided. This corresponds to the "Change to" option that is included in the pop-up menu for model elements in the browser. An element that is not a "new term" can be changed to any of the "new terms" that are based on it. An element that is a "new term" can be changed to the model element that it is based on or to any of the other "new terms" that are based on that base element. Note that when you use this method, you must always use a variable to store the model element that is returned. This is necessary because the original element is destroyed, so you will have problems if you try to access the original element after this method is called.

Parameters:
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.
Returns:
the new model element that was created.

clone

IRPModelElement clone(java.lang.String name,
                      IRPModelElement newOwner)
Clones a model element.

Parameters:
name - the name to use for the new element
newOwner - the model element that should be the owner of the new element
Returns:
the new model element that was created

createOSLCLink

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.

Parameters:
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
Throws:
RhapsodyRuntimeException

deleteDependency

void deleteDependency(IRPDependency dependency)
Deletes the specified dependency from the model.

Parameters:
dependency - the dependency to be deleted

deleteFromProject

void deleteFromProject()
Deletes the current model element from the model.


deleteOSLCLink

void deleteOSLCLink(java.lang.String type,
                    java.lang.String purl)
Deletes the specified OSLC link from the model.

Parameters:
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.
Throws:
RhapsodyRuntimeException

errorMessage

java.lang.String errorMessage()
Returns error message for last method called. If the last method completed successfully, then this method returns an empty string. To get the correct error message for a method, errorMessage() must be called immediately after the method is called.

Returns:
the error message for the last method called

findElementsByFullName

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.
 
 // 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());
 

Parameters:
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.
Returns:
the model element that was specified

findNestedElement

IRPModelElement findNestedElement(java.lang.String name,
                                  java.lang.String metaClass)
Searches for the specified model element. This method only searches the first level of elements below the current element. To search all of the levels below the current element, use the method findNestedElementRecursive.

Parameters:
name - the name of the element to search for
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.
Returns:
the model element that was specified. Note that the element is always returned as an object of type IRPModelElement. So you will usually have to use casting, for example,
IRPPackage packageToUse = (IRPPackage)prj.findNestedElement("GreeterPackage", "Package");

findNestedElementRecursive

IRPModelElement findNestedElementRecursive(java.lang.String name,
                                           java.lang.String metaClass)
Searches recursively for the specified model element. This method searches all of the levels below the current element. To search only the first level of elements below the current element, use the method findNestedElement.

Parameters:
name - the name of the element to search for
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.
Returns:
the model element that was specified. Note that the element is always returned as an object of type IRPModelElement. So you will usually have to use casting, for example,
IRPPackage packageToUse = (IRPPackage)prj.findNestedElementRecursive("GreeterPackage", "Package");

getAllTags

IRPCollection getAllTags()
Returns a collection of all the element's tags.

Returns:
a collection of IRPTag objects representing the element's tags

getAnnotations

IRPCollection getAnnotations()
Returns all of the element's annotations. This includes comments, constraints, and requirements.

Returns:
all of the element's annotations: comments, constraints, and requirements

getAssociationClasses

IRPCollection getAssociationClasses()
Returns a collection of all the association classes directly beneath this model element. This method is only relevant for packages and classifiers.

Returns:
all of the association classes directly beneath this model element

getBinaryID

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.

Returns:
the GUID of the model element as an array of bytes

getConstraints

IRPCollection getConstraints()
Returns all of the element's constraints.

Returns:
all of the element's constraints

getConstraintsByHim

IRPCollection getConstraintsByHim()
For internal use only.


getControlledFiles

IRPCollection getControlledFiles()
Returns a collection of all the element's controlled files.

Returns:
a collection of IRPControlledFile objects representing the element's controlled files

getDecorationStyle

java.lang.String getDecorationStyle()
Returns the name of the decoration style currently associated with the model element.

Returns:
the decoration style currently associated with the model element

getDependencies

IRPCollection getDependencies()
Returns all of the element's dependencies.

Returns:
all of the element's dependencies

getDescription

java.lang.String getDescription()
Returns the description defined for the element.

Returns:
the description for the element

getDescriptionHTML

java.lang.String getDescriptionHTML()
Returns HTML representation of the element description.

Returns:
HTML representation of the element description

getDescriptionPlainText

java.lang.String getDescriptionPlainText()
Returns the description defined for the element in plain text format.

Returns:
the description for the element in plain text format

getDescriptionRTF

java.lang.String getDescriptionRTF()
Returns the description defined for the element in RTF format.

Returns:
the description for the element in RTF format

getDisplayName

java.lang.String getDisplayName()
Returns the label of the model element.

Returns:
the label of the model element

getDisplayNameRTF

java.lang.String getDisplayNameRTF()
Returns the label of the model element as an RTF string.

Returns:
the label of the model element as an RTF string.

getErrorMessage

java.lang.String getErrorMessage()
Returns error message for last method called. If the last method completed successfully, then this method returns an empty string. To get the correct error message for a method, errorMessage() must be called immediately after the method is called.

Returns:
the error message for the last method called

getFullPathName

java.lang.String getFullPathName()
Returns the full path name of the model element. The format of the string returned is package::subpackage::class.
 
  // 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());
 }
 

Returns:
the full path name of the model element. The format of the string returned is package::subpackage::class.

getFullPathNameIn

java.lang.String getFullPathNameIn()
Retrieves the full path name of the element as a string in the following format: (class) in (package).

Returns:
the full path name of the element in the format: (class) in (package)

getGUID

java.lang.String getGUID()
Returns the GUID of the model element. In situations where you may have to carry out multiple searches for the same element, you can use the getGUID method to get the GUID of the element once, and then use the method IRPProject.findElementByGUID which performs a quicker search than the other "find" methods provided.

Returns:
the GUID of the model element

getHyperLinks

IRPCollection getHyperLinks()
Returns a collection of all the hyperlinks associated with the element.

Returns:
a collection of IRPHyperLink objects representing the hyperlinks associated with the element

getIconFileName

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.

Returns:
the full path of the graphic file used to represent elements of this type in the browser

getInterfaceName

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.

Returns:
the name of the API interface corresponding to the current element

getIsExternal

int getIsExternal()
Checks whether the element is an "external" element - corresponds to the value of the property UseAsExternal.

Returns:
1 if the element is an "external" element, 0 otherwise

getIsOfMetaClass

int getIsOfMetaClass(java.lang.String metaClass)
Indicates whether the model element is based on the metaclass provided as a parameter.

Parameters:
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.
Returns:
indication of whether the model element is based on the metaclass specified. 1 means that the model element is based on the metaclass specified, 0 means it is not based on that metaclass.

getIsShowDisplayName

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. This behavior is controlled by the General::Graphics::ShowLabels property.

Returns:
1 if the element is configured to have its label displayed instead of its name in diagrams, 0 otherwise

getIsUnresolved

int getIsUnresolved()
Checks if the element is an element that can't be resolved by Rhapsody.

Returns:
indication of whether the element is an unresolved element - 0 if the element can be resolved, 1 if the element is unresolved

getLocalTags

IRPCollection getLocalTags()
Returns a collection of the tags that were created locally for this model element.

Returns:
the tags that were created locally for the model element (collection of IRPTag elements)

getMainDiagram

IRPDiagram getMainDiagram()
Returns the "main" diagram for the element. This operation is valid only for packages, classes, actors, use cases, objects, and interfaces.

Returns:
the "main" diagram for the element

getMetaClass

java.lang.String getMetaClass()
Gets the name of the metaclass on which the model element is based. Note that if the element is based on a New Term stereotype, the string returned here will be the metaclass on which it is based. To get the name of the New Term stereotype, use the method IRPModelElement.getUserDefinedMetaClass.

Returns:
the name of the metaclasses on which the model element is based. The string returned will be one of the the metaclass names listed in the file metaclasses.txt in the Doc directory of the Rhapsody installation. For example, for an object of type IRPStereotype, the string "Stereotype" will be returned.

getName

java.lang.String getName()
Returns the name of the element.

Returns:
the name of the element

getNestedElements

IRPCollection getNestedElements()
Gets a collection of all the model elements that are directly under the current element. Note that if you call this method on a package, the returned collection will not include functions, global variables, or global objects contained in the package because these are actually contained in a class called TopLevel. To get the functions, global variables, or global objects contained in a package, use the following IRPPackage methods: getGlobalFunctions(), getGlobalVariables(), and getGlobalObjects().

Returns:
a collection of IRPModelElement objects representing all the model elements that are directly under the current element
 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());
 }
 
 

getNestedElementsByMetaClass

IRPCollection getNestedElementsByMetaClass(java.lang.String metaClass,
                                           int recursive)
Retrieves all of the model elements of the specified type below the current element. The second argument can be used to specify whether the retrieval should be 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());
                }
 

Parameters:
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.
Returns:
a collection of the model elements of the specified type below the current element

getNestedElementsRecursive

IRPCollection getNestedElementsRecursive()
Returns a collection that consists of the current element and all of the model elements below it.
 
 // 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());
 }
 

Returns:
a collection consisting of the current element and all of the model elements below it

getNewTermStereotype

IRPStereotype getNewTermStereotype()
If a "new term" stereotype has been applied to the element, returns the stereotype.

Returns:
the "new term" stereotype that was applied to the element

getOSLCLinks

IRPCollection getOSLCLinks()
Returns a collection of all the element's OSLC links. Each item in the collection is a string that uses the following format: "Type=<<link type>>(newline)URL=<<linked item URL>>".

Returns:
all of the element's OSLC links
Throws:
RhapsodyRuntimeException

getOfTemplate

IRPModelElement getOfTemplate()
If the element is an instantiation of a template, this method returns the template that it instantiates.

Returns:
the template that this model element instantiates

getOverlayIconFileName

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.

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

getOverriddenProperties

IRPCollection getOverriddenProperties(int recursive)
Returns a collection of all the properties whose value was overridden for this model element. The collection consists of strings that use the format subject:metaclass:property:value.

Parameters:
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
Returns:
the properties whose value was overridden for this model element

getOverriddenPropertiesByPattern

IRPCollection getOverriddenPropertiesByPattern(java.lang.String pattern,
                                               int localyOverridenOnly,
                                               int withDefaultValues)
method getOverriddenPropertiesByPattern

Throws:
RhapsodyRuntimeException

getOwnedDependencies

IRPCollection getOwnedDependencies()
Returns all of the dependencies that are owned by the element.

Returns:
all of the dependencies that are owned by this element
Throws:
RhapsodyRuntimeException

getOwner

IRPModelElement getOwner()
Returns the model element that owns this model element.

Returns:
the model element that owns this model element

getProject

IRPProject getProject()
Returns the project that the current element belongs to.

Returns:
the project the current element belongs to

getPropertyValue

java.lang.String getPropertyValue(java.lang.String propertyKey)
Returns the value of the specified property for the model element.

Parameters:
propertyKey - the property whose value should be returned. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadName
Returns:
the value of the specified property. If a value has not been set specifically for this element, the default value is returned (the value propagated from a higher level)

getPropertyValueConditional

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. For more information on using tokens in property values, see "Conditional Properties" in the Rational Rhapsody help.

Parameters:
propertyKey - the property whose value should be returned. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadName
formalKey - the collection of tokens to take into account (collection of strings)
actualValues - the collection of token values to take into account (collection of strings)
Returns:
the value of the specified property, taking into account the tokens and token values specified. If a value has not been set specifically for this element, the default value is returned (the value propagated from a higher level)

getPropertyValueConditionalExplicit

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. For more information on using tokens in property values, see "Conditional Properties" in the Rational Rhapsody help. If a value has not been set explicitly for the model element, the method will not return the default value (like the getPropertyValueConditional method does). Rather, it will throw an exception.

Parameters:
propertyKey - the property whose value should be returned. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadName
formalKey - the collection of tokens to take into account (collection of strings)
actualValues - the collection of token values to take into account (collection of strings)
Returns:
the value that was explicitly set for the model element for the specified property, taking into account the tokens and token values specified

getPropertyValueExplicit

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. If a value has not been set explicitly for the model element, it will not return the default value (like the getPropertyValue method does). Rather, it will throw an exception.

Parameters:
propertyKey - the property whose value should be returned. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadName
Returns:
the value that was explicitly set for the model element for the specified property

getRedefines

IRPCollection getRedefines()
method getRedefines

Throws:
RhapsodyRuntimeException

getReferences

IRPCollection getReferences()
Returns a collection of all the model elements that point to this model element.

Returns:
all the model elements that point to this model element

getRemoteDependencies

IRPCollection getRemoteDependencies()
For Design Manager projects, returns a collection of all the dependencies that the model element has on remote elements.

Returns:
all the dependencies that the model element has on remote elements

getRemoteURI

java.lang.String getRemoteURI()
For elements that are remote resources, returns the URI of the resource.

Returns:
the URI of the remote resource. If the method is called for an element that is not a remote resource, an empty string is returned.

getRequirementTraceabilityHandle

int getRequirementTraceabilityHandle()
Returns the ID used by DOORS to refer to this requirement.

Returns:
the ID used by DOORS to refer to this requirement

getSaveUnit

IRPUnit getSaveUnit()
Returns the unit that the model element is saved in.

Returns:
the unit that the element is saved in

getStereotype

IRPStereotype getStereotype()
Deprecated. Since Rhapsody now allows multiple stereotypes to be applied to a model element, the getStereotypes() method should be used instead.


getStereotypes

IRPCollection getStereotypes()
Returns a collection of the stereotypes that have been applied to the element.

Returns:
the stereotypes that have been applied to the element

getTag

IRPTag getTag(java.lang.String name)
Returns the tag specified. This method can be used for both local tags and global tags.

Parameters:
name - the name of the tag to return
Returns:
the tag specified

getTemplateParameters

IRPCollection getTemplateParameters()
For model elements that are templates, returns the template parameters.

Returns:
the parameters of the template

getTi

IRPTemplateInstantiation getTi()
For model elements that are template instantiations, returns an object that contains the template instantiation parameters.

Returns:
object that contains the template instantiation parameters

getToolTipHTML

java.lang.String getToolTipHTML()
Returns the HTML that would be used to display the tooltip for the element in the user interface.

Returns:
the HTML that would be used to display the tooltip for the element in the user interface

getUserDefinedMetaClass

java.lang.String getUserDefinedMetaClass()
Gets the name of the New Term on which the model element is based.

Returns:
the name of the New Term on which the model element is based. The string returned will be the name of the New Term stereotype that you defined. To get the name of the metaclass on which the New Term is based, use the method IRPModelElement.getMetaClass().

hasNestedElements

int hasNestedElements()
Checks whether the model element contains other elements.

Returns:
1 if the model element contains other elements, 0 otherwise

hasPanelWidget

int hasPanelWidget()
Checks whether the model element is bound to a panel diagram widget.

Returns:
1 if the element is bound to a panel diagram widget, 0 otherwise

highLightElement

void highLightElement()
Locates the element in the Rhapsody browser, and highlights the element in the diagram where it appears. Note that the element will be highlighted in the diagram only if it is the kind of element that can appear in only one diagram, for example, a state.


isATemplate

int isATemplate()
Checks whether the model element is a template.

Returns:
1 if the element is a template, 0 otherwise

isDescriptionRTF

int isDescriptionRTF()
Checks whether the description for the element is in RTF format.

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

isDisplayNameRTF

int isDisplayNameRTF()
Checks whether the label of the element is in RTF format.

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

isModified

int isModified()
Checks if the element was modified since the model was last saved.

Returns:
1 if the element was modified since the model was last saved, 0 if the element was not modified

isRemote

int isRemote()
Checks whether the model element is a remote resource such as a DOORS/DNG requirement.

Returns:
1 if the element is a remote resource, 0 if not

locateInBrowser

int locateInBrowser()
Locates the model element in the Rhapsody browser.

Returns:
returns 1 if the element was located in the browser

lockOnDesignManager

void lockOnDesignManager()
Locks the model element on the Design Manager server.


openFeaturesDialog

void openFeaturesDialog(int newDialog)
Displays the information for the element in the Features window. Depending on the value of the parameter provided, opens a new Features window or uses an already-open Features window.

Parameters:
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.

removeProperty

void removeProperty(java.lang.String propertyKey)
Removes the value that was set for the specified property. This is equivalent to the "un-override" option in the Features window.

Parameters:
propertyKey - the property whose value should be removed. The syntax to use for this parameter is Subject.Metaclass.Property, for example, CG.Class.ActiveThreadName

removeRedefines

void removeRedefines(IRPModelElement removedRedefine)
method removeRedefines

Throws:
RhapsodyRuntimeException

removeStereotype

void removeStereotype(IRPStereotype stereotype)
Removes the specified stereotype from the element.

Parameters:
stereotype - the stereotype to be removed from the element

setDecorationStyle

void setDecorationStyle(java.lang.String newVal)
Used to specify the decoration style that should now be associated with the model element.

Parameters:
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.

setDescription

void setDescription(java.lang.String description)
Sets the specified string as the description of the element.

Parameters:
description - the string to use as the description of the element

setDescriptionAndHyperlinks

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.

Parameters:
rtfText - the string to use for the element description - must be in RTF format
targets - the collection of elements for which hyperlinks should be created

setDescriptionHTML

void setDescriptionHTML(java.lang.String descriptionHTML)
Specifies the HTML text to use for the description of the model element.

Parameters:
descriptionHTML - the HTML text to use for the description of the model element

setDescriptionRTF

void setDescriptionRTF(java.lang.String descriptionRTF)
Specifies the RTF string to use for the description of the model element.

Parameters:
descriptionRTF - the RTF string to use for the description of the model element

setDisplayName

void setDisplayName(java.lang.String displayName)
Specifies the text to use for the label of the model element.

Parameters:
displayName - the text to use for the label of the model element

setDisplayNameRTF

void setDisplayNameRTF(java.lang.String newVal)
Specifies the RTF string to use for the label of the model element.

Parameters:
newVal - the RTF string to use for the label of the model element

setGUID

void setGUID(java.lang.String gUID)
Sets a new GUID for the model element.

Parameters:
gUID - the new GUID that should be used for the model element

setIsShowDisplayName

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. This method changes the value of the General::Graphics::ShowLabels property.

Parameters:
isShowDisplayName - use 1 if you want the label of the element displayed, use 0 if you want the name of the element displayed

setMainDiagram

void setMainDiagram(IRPDiagram mainDiagram)
Specifies the "main" diagram for the element. This operation is valid only for packages, classes, actors, use cases, objects, and interfaces.

Parameters:
mainDiagram - the diagram to use as the "main" diagram for the element

setName

void setName(java.lang.String name)
Sets the specified string as the name of the element.

Parameters:
name - the string to use as the name of the element

setOfTemplate

void setOfTemplate(IRPModelElement ofTemplate)
Makes the current model element a template instantiation of the specified template.

Parameters:
ofTemplate - the template to use for the instantiation

setOwner

void setOwner(IRPModelElement owner)
Specifies the model element that should be the owner of this element.

Parameters:
owner - the model element that should be the owner of this element

setPropertyValue

void setPropertyValue(java.lang.String propertyKey,
                      java.lang.String propertyValue)
Sets the value of a property for the model element.

Parameters:
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".

setRequirementTraceabilityHandle

void setRequirementTraceabilityHandle(int requirementTraceabilityHandle)
Sets a new ID to be used to reference this requirement

Parameters:
requirementTraceabilityHandle - the new ID that should be used to reference this requirement

setStereotype

void setStereotype(IRPStereotype stereotype)
Applies the specified stereotype to the element.

Parameters:
stereotype - the stereotype to be applied to the element

setTagContextValue

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.

Parameters:
tag - the tag to apply to the model element
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.
Returns:
the tag created for the model element

setTagElementValue

IRPTag setTagElementValue(IRPTag tag,
                          IRPModelElement val)
Applies a tag whose type is a model element to the current element with the value specified. If the tag has already been applied to the current element, the method can be used to modify the value of the tag.

Parameters:
tag - the tag to apply to the element
val - the value to use for the tag applied
Returns:
the tag created for the model element

setTagValue

IRPTag setTagValue(IRPTag tag,
                   java.lang.String val)
Applies the specified tag to the model element with the value specified. If the tag has already been applied to the model element, the method can be used to modify the value of the tag.

Parameters:
tag - the tag to apply to the element
val - the value to use for the tag applied
Returns:
the tag created for the model element

setTi

void setTi(IRPTemplateInstantiation ti)
For internal use only.


synchronizeTemplateInstantiation

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.


unlockOnDesignManager

void unlockOnDesignManager()
Unlocks the model element on the Design Manager server.