com.telelogic.rhapsody.core
Interface IRPProject

All Superinterfaces:
IRPModelElement, IRPPackage, IRPUnit

public interface IRPProject
extends IRPPackage

The IRPProject interface represents Rational Rhapsody projects.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPComponent addComponent(java.lang.String name)
          Adds a new Component to the project.
 void addCustomViewOnBrowser(IRPPackage customView)
          Applies the specified custom view to the model browser.
 void addCustomViewOnDiagram(IRPDiagram diagram, IRPPackage customView)
          Applies the specified custom view to the specified diagram.
 IRPPackage addPackage(java.lang.String name)
          Adds a new package to the project.
 IRPProfile addProfile(java.lang.String name)
          Adds a new profile to the project.
 void addSpellCheckerResult(java.lang.String value)
          For internal use only.
 void allowAutoSave(int allow)
          Can be used to temporarily disable autosaving of the model regardless of the current value of the property General::Model::AutoSaveInterval.
 void allowNonUniqueNames(int allow)
          For internal use only.
 void applyBrowserCustomViewsOnDiagrams(int newVal)
          Applies the custom views applied to the browser to all diagrams as well.
 void applyRoundtripDiffMerge(int magicNumber, IRPProject shadowModel, IRPCollection filesToUpdate)
          For internal use only.
 void becomeActiveProject()
          Makes this project the active project in Rhapsody.
 void checkEventsBaseIdsSolveCollisions()
          Checks the values of the event base IDs for all packages in the model, detects collisions between the IDs, and resolves any incorrect values and collisions.
 void cleanUnresolvedElements(IRPModelElement rootElement)
          Removes any unresolved elements from the model, starting at the level of the specified element and working downward.
 void close()
          Closes the project.
 void closeCSVFile(java.lang.String fullCSVFileName)
          Closes the tab in the Output window for the specified csv file.
 void deleteComponent(IRPComponent component)
          Deletes the specified Component.
 void endTransactionOfNoCGInterest()
          For internal use only.
 IRPComponent findComponent(java.lang.String name)
          Returns the Component with the specified name.
 IRPModelElement findElementByBinaryID(byte[] theID)
          Retrieves a model element based on its binary ID.
 IRPModelElement findElementByFileName(java.lang.String theFolderName, java.lang.String theFileName)
          Returns the top-level element in the specified Rhapsody unit file.
 IRPModelElement findElementByGUID(java.lang.String theGUID)
          Retrieves a model element based on its GUID.
 IRPCollection findElementsWithOSLCLink(java.lang.String type, java.lang.String purl)
          Returns a collection of all the model elements that have an OSLC link of the specified type to the specified target element.
 void gatewayExportToXML(java.lang.String filename, java.lang.String params)
          For internal use only.
 void gatewayExportToXML2(java.lang.String filename, java.lang.String params, IRPProject proj)
          For internal use only.
 void generateReport(java.lang.String modelscope, java.lang.String templatename, java.lang.String docType, java.lang.String filename, int showDocument, int silentMode)
          Generates a ReporterPLUS report for the model.
 IRPComponent getActiveComponent()
          Returns the active component.
 IRPConfiguration getActiveConfiguration()
          Returns the active configuration.
 IRPCollection getActiveCustomViewsOnBrowser()
          Returns a collection of the custom views currently applied to the browser.
 IRPCollection getActiveCustomViewsOnDiagram(IRPDiagram diagram)
          Returns a collection of the custom views currently applied to the specified diagram.
 IRPCollection getAllStereotypes()
          Returns a collection of all the stereotypes in the project.
 IRPPackage getCgSimplifiedModelPackage()
          Returns the package that contains the simplified model.
 IRPCollection getCodeGeneratedFiles()
          Returns a collection of filenames for the code files that will be generated for the current active component if you select the "regenerate" option.
 IRPCollection getComponents()
          Returns a collection of all the components in the project.
 java.lang.String getDefaultDirectoryScheme()
          Returns the project's default directory scheme with regard to packages.
 IRPCollaboration getNewCollaboration()
          Creates a new IRPCollaboration object that can be used to create a sequence diagram.
 IRPProgressBar getNewProgressBar(int amount, java.lang.String name)
          method getNewProgressBar
 int getNotifyPluginOnElementsChanged()
          Checks whether plugins will be notified when model elements are modified.
 IRPCollection getProfiles()
          Returns a collection of all the profiles in the project.
 IRPCollection getRemoteResourcePackages()
          For Design Manager projects, returns the packages of remote requirements (the "Remote Resource Packages").
 IRPCollection getRequirementsByID(java.lang.String requirementID, int returnFirstFoundOnly)
          Returns all of the requirements that have the specified ID.
 IRPProject getRoundtripShadowModel(int magicNumber)
          For internal use only.
 IRPModelElement highlightFromCode(java.lang.String filename, int lineNumber)
          Highlights in the Rhapsody browser the model element associated with the specified line of code.
 void importPackageFromRose(java.lang.String projectName, java.lang.String packageName, java.lang.String logFileName)
          Imports the specified Rose package.
 void importProjectFromRose(java.lang.String projectName, java.lang.String logFileName)
          Imports the specified Rose project.
 int isActivelyManaged()
          Checks whether the project is an actively-managed Design Manager project.
 int isModifiedRecursive()
          Checks whether any part of the project has been modified and the project needs to be saved.
 void locateInIDE(IRPConfiguration config, java.lang.String filename, int lineNumber)
          For projects that use Rhapsody's integration with Eclipse or Visual Studio, you can use the locateInIDE method to have the IDE highlight a specific line in a specific source file.
 void moveToDesignManager(java.lang.String userName, java.lang.String password, java.lang.String serverURL, java.lang.String projectAreaName, java.lang.String streamName)
          Moves the model to a Rhapsody Design Manager server.
 void moveToDesignManagerAfterLogin(java.lang.String serverURL, java.lang.String projectAreaName, java.lang.String streamName)
          Moves the model to a Rhapsody Design Manager server.
 void openCSVFile(java.lang.String fullCSVFileName, int reserved)
          Displays the content of the specified csv file in a new tab in the Output window.
 void recalculateEventsBaseIds()
          If you are using Rational Rhapsody's default numbering scheme for event IDs, then a certain amount of IDs are reserved for each package.
 void reloadCSVFile(java.lang.String fullCSVFileName)
          Reloads the content of the specified csv file in a tab in the Output window.
 int remove()
          Removes the project from the Rhapsody workspace.
 void removeCustomViewOnBrowser(IRPPackage customView)
          Removes the specified custom view from the model browser.
 void removeCustomViewOnDiagram(IRPDiagram diagram, IRPPackage customView)
          Removes the specified custom view from the specified diagram.
 void save()
          Saves the project.
 void saveAs(java.lang.String filename)
          Saves the project using the specified path.
 void saveAsPrevVersion(java.lang.String filename, java.lang.String prevVersion)
          Saves the project, using the format of a previous version of Rhapsody.
 void setActiveComponent(IRPComponent activeComponent)
          Sets the specified component as the active component for the project.
 void setActiveComponent(java.lang.String name)
          Sets the specified component as the active component for the project.
 void setActiveConfiguration(IRPConfiguration activeConfiguration)
          Sets the specified configuration to be the active configuration of the project.
 void setActiveConfiguration(java.lang.String name)
          Sets the specified configuration to be the active configuration of the project.
 void setDefaultDirectoryScheme(java.lang.String defaultDirectoryScheme)
          Set's the project's default directory scheme with regard to packages.
 void setNotifyPluginOnElementsChanged(int val)
          For plugins that use the callback API, you must call the method setNotifyPluginOnElementsChanged if you want the plugin to be notified when model elements are modified.
 void setObjectExplicit(IRPInstance pInstance)
          Changes the specified object to an explicit object.
 void setObjectImplicit(IRPInstance pInstance)
          Changes the specified object to an implicit object.
 void setUseUniqueStereotypeAndRefCache(int useUniqueStereotypeAndRefCache)
          This method can be used to specify that all of the stereotypes in the model should be cached to allow quicker retrieval.
 void setWaitDialogWatchdogValue(java.lang.String value)
          The method setWaitDialogWatchdogValue provides a mechanism that allows an external process to inform Rhapsody that the process has ended or crashed.
 void startTransactionOfNoCGInterest()
          For internal use only.
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPPackage
addActivityDiagram, addActor, addClass, addCollaborationDiagram, addComponentDiagram, addDeploymentDiagram, addEvent, addFlowItems, addFlows, addGlobalFunction, addGlobalObject, addGlobalVariable, addImplicitObject, addLink, addLinkBetweenSYSMLPorts, addModule, addNestedPackage, addNode, addObjectModelDiagram, addPanelDiagram, addSequenceDiagram, addStatechart, addTimingDiagram, addType, addUseCase, addUseCaseDiagram, deleteActor, deleteClass, deleteCollaborationDiagram, deleteComponentDiagram, deleteDeploymentDiagram, deleteEvent, deleteFlowItems, deleteFlows, deleteGlobalFunction, deleteGlobalObject, deleteGlobalVariable, deleteNode, deleteObjectModelDiagram, deletePackage, deletePanelDiagram, deleteSequenceDiagram, deleteTimingDiagram, deleteType, deleteUseCase, deleteUseCaseDiagram, findActor, findAllByName, findClass, findEvent, findGlobalFunction, findGlobalObject, findGlobalVariable, findNode, findType, findUsage, findUseCase, getActors, getAllNestedElements, getBehavioralDiagrams, getClasses, getCollaborationDiagrams, getComponentDiagrams, getDeploymentDiagrams, getEvents, getEventsBaseId, getFlowItems, getFlows, getGlobalFunctions, getGlobalObjects, getGlobalVariables, getInstanceSpecifications, getLinks, getModules, getNamespace, getNestedClassifiers, getNestedComponents, getNodes, getObjectModelDiagrams, getPackages, getPanelDiagrams, getRemoteRequirementsPopulateMode, getSavedInSeperateDirectory, getSequenceDiagrams, getSourceArtifacts, getTimingDiagrams, getTypes, getUseCaseDiagrams, getUseCases, getUserDefinedStereotypes, populateRemoteRequirements, reCalculateEventsBaseId, setRemoteRequirementsPopulateMode, setSavedInSeperateDirectory
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPUnit
copyToAnotherProject, getAddToModelMode, getCMHeader, getCMState, getCurrentDirectory, getFilename, getIncludeInNextLoad, getIsStub, getLanguage, getLastModifiedTime, getNestedSaveUnits, getNestedSaveUnitsCount, getStructureDiagrams, isReadOnly, isReferenceUnit, isSeparateSaveUnit, load, moveToAnotherProjectLeaveAReference, referenceToAnotherProject, save, setCMHeader, setFilename, setIncludeInNextLoad, setLanguage, setReadOnly, setSeparateSaveUnit, setUnitPath, unload
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPModelElement
addAssociation, addDependency, addDependencyBetween, addDependencyTo, addLinkToElement, addNewAggr, addProperty, addRedefines, addRemoteDependencyTo, addSpecificStereotype, addStereotype, becomeTemplateInstantiationOf, changeTo, clone, createOSLCLink, deleteDependency, deleteFromProject, deleteOSLCLink, errorMessage, findElementsByFullName, findNestedElement, findNestedElementRecursive, getAllTags, getAnnotations, getAssociationClasses, getBinaryID, getConstraints, getConstraintsByHim, getControlledFiles, getDecorationStyle, getDependencies, getDescription, getDescriptionHTML, getDescriptionPlainText, getDescriptionRTF, getDisplayName, getDisplayNameRTF, getErrorMessage, getFullPathName, getFullPathNameIn, getGUID, getHyperLinks, getIconFileName, getInterfaceName, getIsExternal, getIsOfMetaClass, getIsShowDisplayName, getIsUnresolved, getLocalTags, getMainDiagram, getMetaClass, getName, getNestedElements, getNestedElementsByMetaClass, getNestedElementsRecursive, getNewTermStereotype, getOfTemplate, getOSLCLinks, getOverlayIconFileName, getOverriddenProperties, getOverriddenPropertiesByPattern, getOwnedDependencies, getOwner, getProject, getPropertyValue, getPropertyValueConditional, getPropertyValueConditionalExplicit, getPropertyValueExplicit, getRedefines, getReferences, getRemoteDependencies, getRemoteURI, getRequirementTraceabilityHandle, getSaveUnit, getStereotype, getStereotypes, getTag, getTemplateParameters, getTi, getToolTipHTML, getUserDefinedMetaClass, hasNestedElements, hasPanelWidget, highLightElement, isATemplate, isDescriptionRTF, isDisplayNameRTF, isModified, isRemote, locateInBrowser, lockOnDesignManager, openFeaturesDialog, removeProperty, removeRedefines, removeStereotype, setDecorationStyle, setDescription, setDescriptionAndHyperlinks, setDescriptionHTML, setDescriptionRTF, setDisplayName, setDisplayNameRTF, setGUID, setIsShowDisplayName, setMainDiagram, setName, setOfTemplate, setOwner, setPropertyValue, setRequirementTraceabilityHandle, setStereotype, setTagContextValue, setTagElementValue, setTagValue, setTi, synchronizeTemplateInstantiation, unlockOnDesignManager
 

Method Detail

gatewayExportToXML

void gatewayExportToXML(java.lang.String filename,
                        java.lang.String params)
For internal use only.


gatewayExportToXML2

void gatewayExportToXML2(java.lang.String filename,
                         java.lang.String params,
                         IRPProject proj)
For internal use only.


generateReport

void generateReport(java.lang.String modelscope,
                    java.lang.String templatename,
                    java.lang.String docType,
                    java.lang.String filename,
                    int showDocument,
                    int silentMode)
Generates a ReporterPLUS report for the model. (When this method is used to generate a report, the Rhapsody model is saved before the report is generated.)
 
 // Sample code:
 IRPProject currentProject = app.activeProject();
 currentProject.generateReport("", "C:\Rhapsody\reporterplus\Templates\Class.tpl", "html", "C:\testreport.html", 0, 0);
 

Parameters:
modelscope - the name of the package for which the report should be generated. If empty, a report is generated for the entire model. (This is similar to the "scope" command-line option for ReporterPLUS.)
templatename - the name of the template to use. If empty, then the ReporterPLUS report generation wizard will be launched and it will display the name of the last template used.
docType - the type of output to generate (doc, html, ppt, txt). If empty, the ReporterPLUS report generation wizard will be launched and it will display the last output type used.
filename - the filename to use for the generated report. If empty, the ReporterPLUS report generation wizard will be displayed and it will display the filename of the last generated report.
showDocument - In general, the user will be asked if they want to view the report after generation only if they have requested this by selecting View > Options > Ask to open after generating report from the main menu in ReporterPLUS. However, if the user has specified silent generation mode using the parameter silentMode, this parameter can be used to request that the generated document be displayed. To display the report, set this parameter to 1, otherwise use 0.
silentMode - If the template name, document type, or output file name has not been specified using the appropriate parameter, the ReporterPLUS report generation wizard is displayed so the user can provide the missing information. This is the behavior if this parameter is set to 0. If you want to prevent the wizard from being launched in such cases, you can specify silent generation mode by setting this parameter to 1. If set to silent mode, no report will be generated if one or more of the above parameters was not provided. (The report generation status dialog is displayed regardless of the value of this parameter.)

addComponent

IRPComponent addComponent(java.lang.String name)
Adds a new Component to the project.

Parameters:
name - the name to use for the new Component
Returns:
the Component that was created

addCustomViewOnBrowser

void addCustomViewOnBrowser(IRPPackage customView)
Applies the specified custom view to the model browser.

Parameters:
customView - the custom view that should be applied to the browser
Throws:
RhapsodyRuntimeException

addCustomViewOnDiagram

void addCustomViewOnDiagram(IRPDiagram diagram,
                            IRPPackage customView)
Applies the specified custom view to the specified diagram.

Parameters:
diagram - the diagram to which the custom view should be applied
customView - the custom view that should be applied to the diagram
Throws:
RhapsodyRuntimeException

addPackage

IRPPackage addPackage(java.lang.String name)
Adds a new package to the project.

Parameters:
name - the name to use for the new package
Returns:
the package that was created

addProfile

IRPProfile addProfile(java.lang.String name)
Adds a new profile to the project.

Parameters:
name - the name to use for the new profile
Returns:
the profile that was created

addSpellCheckerResult

void addSpellCheckerResult(java.lang.String value)
For internal use only.


allowAutoSave

void allowAutoSave(int allow)
Can be used to temporarily disable autosaving of the model regardless of the current value of the property General::Model::AutoSaveInterval.

Parameters:
allow - Use 0 to turn off autosave, use 1 to turn autosave on

allowNonUniqueNames

void allowNonUniqueNames(int allow)
For internal use only.


applyBrowserCustomViewsOnDiagrams

void applyBrowserCustomViewsOnDiagrams(int newVal)
Applies the custom views applied to the browser to all diagrams as well.

Parameters:
newVal - Use 1 to apply the custom views to all diagrams, 0 to remove the custom views from the diagrams
Throws:
RhapsodyRuntimeException

applyRoundtripDiffMerge

void applyRoundtripDiffMerge(int magicNumber,
                             IRPProject shadowModel,
                             IRPCollection filesToUpdate)
For internal use only.


becomeActiveProject

void becomeActiveProject()
Makes this project the active project in Rhapsody. For use when you have multiple projects open in Rhapsody.


checkEventsBaseIdsSolveCollisions

void checkEventsBaseIdsSolveCollisions()
Checks the values of the event base IDs for all packages in the model, detects collisions between the IDs, and resolves any incorrect values and collisions.


cleanUnresolvedElements

void cleanUnresolvedElements(IRPModelElement rootElement)
Removes any unresolved elements from the model, starting at the level of the specified element and working downward.

Parameters:
rootElement - the element below which Rhapsody should remove all unresolved elements

close

void close()
Closes the project.


closeCSVFile

void closeCSVFile(java.lang.String fullCSVFileName)
Closes the tab in the Output window for the specified csv file.

Parameters:
fullCSVFileName - the path of the csv file that should be closed

deleteComponent

void deleteComponent(IRPComponent component)
Deletes the specified Component.

Parameters:
component - the Component that should be deleted

endTransactionOfNoCGInterest

void endTransactionOfNoCGInterest()
For internal use only.


findComponent

IRPComponent findComponent(java.lang.String name)
Returns the Component with the specified name.

Parameters:
name - the name of the Component to return
Returns:
the Component with the specified name

findElementByBinaryID

IRPModelElement findElementByBinaryID(byte[] theID)
Retrieves a model element based on its binary ID. This operation can be used in conjunction with the operation IRPModelElement.getBinaryID, which returns the binary ID of the element. In some situations, findElementByBinaryID is faster than the operation IRPProject.findElementByGUID.

Parameters:
theID - the binary ID for the model element that should be retrieved
Returns:
the model element with the specified binary ID

findElementByFileName

IRPModelElement findElementByFileName(java.lang.String theFolderName,
                                      java.lang.String theFileName)
Returns the top-level element in the specified Rhapsody unit file. For example, the top-level package is returned for an sbs file, and the class element is returned for a cls file.

Parameters:
theFolderName - the full path of the folder that contains the unit file
theFileName - the filename for the unit file
Returns:
the top-level element in the specified Rhapsody unit file
Throws:
RhapsodyRuntimeException

findElementByGUID

IRPModelElement findElementByGUID(java.lang.String theGUID)
Retrieves a model element based on its GUID.

Parameters:
theGUID - the GUID for the model element that should be retrieved
Returns:
the model element with the specified GUID

findElementsWithOSLCLink

IRPCollection findElementsWithOSLCLink(java.lang.String type,
                                       java.lang.String purl)
Returns a collection of all the model elements that have an OSLC link of the specified type to the specified target element.

Parameters:
type - the link type of the OSLC link. 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 "*" to find all the model elements that have any link of the specified type.
Returns:
collection of the model elements that have an OSLC link of the specified type to the specified target element
Throws:
RhapsodyRuntimeException

getActiveComponent

IRPComponent getActiveComponent()
Returns the active component.

Returns:
the active component

getActiveConfiguration

IRPConfiguration getActiveConfiguration()
Returns the active configuration.

Returns:
the active configuration

getActiveCustomViewsOnBrowser

IRPCollection getActiveCustomViewsOnBrowser()
Returns a collection of the custom views currently applied to the browser.

Returns:
the custom views currently applied to the browser
Throws:
RhapsodyRuntimeException

getActiveCustomViewsOnDiagram

IRPCollection getActiveCustomViewsOnDiagram(IRPDiagram diagram)
Returns a collection of the custom views currently applied to the specified diagram.

Parameters:
diagram - the diagram whose custom views should be returned
Returns:
the custom views currently applied to the specified diagram
Throws:
RhapsodyRuntimeException

getAllStereotypes

IRPCollection getAllStereotypes()
Returns a collection of all the stereotypes in the project.

Returns:
all the stereotypes in the project

getCgSimplifiedModelPackage

IRPPackage getCgSimplifiedModelPackage()
Returns the package that contains the simplified model.

Returns:
the package that contains the simplified model

getCodeGeneratedFiles

IRPCollection getCodeGeneratedFiles()
Returns a collection of filenames for the code files that will be generated for the current active component if you select the "regenerate" option. Note that this does not refer to which files were actually generated the last time that code generation was carried out.

Returns:
collection of filenames for the code files that will be generated for the current active component if you select the "regenerate" option

getComponents

IRPCollection getComponents()
Returns a collection of all the components in the project.

Returns:
all the components in the project

getDefaultDirectoryScheme

java.lang.String getDefaultDirectoryScheme()
Returns the project's default directory scheme with regard to packages. "Flat" means that all new units are saved in a single directory. "PackageAsDirectory" means that a new directory is created for each package in the model. This setting is controlled by the property General::Model::DefaultDirectoryScheme.

Returns:
the project's default directory scheme with regard to packages - Flat or PackageAsDirectory

getNewCollaboration

IRPCollaboration getNewCollaboration()
Creates a new IRPCollaboration object that can be used to create a sequence diagram.

Returns:
the IRPCollaboration object that was created

getNewProgressBar

IRPProgressBar getNewProgressBar(int amount,
                                 java.lang.String name)
method getNewProgressBar

Throws:
RhapsodyRuntimeException

getNotifyPluginOnElementsChanged

int getNotifyPluginOnElementsChanged()
Checks whether plugins will be notified when model elements are modified.

Returns:
1 if plugins are to be notified when model elements are modified, 0 otherwise.
Throws:
RhapsodyRuntimeException

getProfiles

IRPCollection getProfiles()
Returns a collection of all the profiles in the project.

Returns:
all the profiles in the project

getRemoteResourcePackages

IRPCollection getRemoteResourcePackages()
For Design Manager projects, returns the packages of remote requirements (the "Remote Resource Packages"). The collection returned consists or IRPPackage objects. You can then cycle through the individual packages to access the individual requirements.

Returns:
the packages of remote requirements

getRequirementsByID

IRPCollection getRequirementsByID(java.lang.String requirementID,
                                  int returnFirstFoundOnly)
Returns all of the requirements that have the specified ID. This refers to the ID field in the Features dialog for requirements. For models where you know that only one requirement can have a given ID, you can use the second parameter to specify that only the first matching requirement should be returned - this option can be useful in large models.

Parameters:
requirementID - the ID to use for the search
returnFirstFoundOnly - use 1 if you want the method to return only the first matching requirement, 0 if you want the method to return all matching requirements
Returns:
all of the requirements that have the specified ID
Throws:
RhapsodyRuntimeException

getRoundtripShadowModel

IRPProject getRoundtripShadowModel(int magicNumber)
For internal use only.


highlightFromCode

IRPModelElement highlightFromCode(java.lang.String filename,
                                  int lineNumber)
Highlights in the Rhapsody browser the model element associated with the specified line of code.
 IRPProject prj = app.openProject("d:\\temp\\_sample_code\\First_Project.rpy");
 prj.highlightFromCode("d:\\temp\\_sample_code\\DefaultComponent\\DefaultConfig\\class_0.h", 42);
 
 

Parameters:
filename - the absolute path for the relevant source file
lineNumber - the line number in the file
Returns:
the model element associated with the specified line of code
Throws:
RhapsodyRuntimeException

importPackageFromRose

void importPackageFromRose(java.lang.String projectName,
                           java.lang.String packageName,
                           java.lang.String logFileName)
Imports the specified Rose package. Beginning in release 8.1.4, this method is no longer supported.

Parameters:
projectName - the Rose project from which the package should be imported (path that includes the name of the *.mdl file)
packageName - the name of the Rose package to import
logFileName - the file to use for logging the import process

importProjectFromRose

void importProjectFromRose(java.lang.String projectName,
                           java.lang.String logFileName)
Imports the specified Rose project. Beginning in release 8.1.4, this method is no longer supported.

Parameters:
projectName - the Rose project to import (path that includes the name of the *.mdl file)
logFileName - the file to use for logging the import process

isActivelyManaged

int isActivelyManaged()
Checks whether the project is an actively-managed Design Manager project.

Returns:
1 if the project is an actively-managed DM project, 0 otherwise
Throws:
RhapsodyRuntimeException

isModifiedRecursive

int isModifiedRecursive()
Checks whether any part of the project has been modified and the project needs to be saved.

Returns:
1 if any part of the project has been modified, 0 if no changes have been made

locateInIDE

void locateInIDE(IRPConfiguration config,
                 java.lang.String filename,
                 int lineNumber)
For projects that use Rhapsody's integration with Eclipse or Visual Studio, you can use the locateInIDE method to have the IDE highlight a specific line in a specific source file.

Parameters:
config - the Rhapsody configuration (of type Eclipse or Visual Studio configuration) that contains the generated source file
filename - the name of the file that should be opened in the IDE
lineNumber - the line number of the line that should be highlighted
Throws:
RhapsodyRuntimeException

moveToDesignManager

void moveToDesignManager(java.lang.String userName,
                         java.lang.String password,
                         java.lang.String serverURL,
                         java.lang.String projectAreaName,
                         java.lang.String streamName)
Moves the model to a Rhapsody Design Manager server. Note that this operation is only intended for the initial move of a model to the DM server. It cannot be used to replace an existing model on the server.

Parameters:
userName - the username for logging in to the Design Manager server
password - the password for logging in to the Design Manager server
serverURL - the URL of the Design Manager server
projectAreaName - the name of the Project Area to use for this model
streamName - the name of the Stream to use for this model

moveToDesignManagerAfterLogin

void moveToDesignManagerAfterLogin(java.lang.String serverURL,
                                   java.lang.String projectAreaName,
                                   java.lang.String streamName)
Moves the model to a Rhapsody Design Manager server. Before calling this method, you must call one of the DM login methods in IRPApplication, such as loginToDesignManagerWithUsername. Note that this operation is only intended for the initial move of a model to the DM server. It cannot be used to replace an existing model on the server.

Parameters:
serverURL - the URL of the Design Manager server
projectAreaName - the name of the Project Area to use for this model
streamName - the name of the Stream to use for this model
Throws:
RhapsodyRuntimeException

openCSVFile

void openCSVFile(java.lang.String fullCSVFileName,
                 int reserved)
Displays the content of the specified csv file in a new tab in the Output window.

Parameters:
fullCSVFileName - the path of the csv file that should be displayed
reserved - this parameter has no effect, you can use any integer

recalculateEventsBaseIds

void recalculateEventsBaseIds()
If you are using Rational Rhapsody's default numbering scheme for event IDs, then a certain amount of IDs are reserved for each package. As a result, there are situations where the IDs used for events in a given package may not be continuous. In cases like this, you can use the method recalculateEventsBaseIds to have the event ID numbering recalculated so that event IDs are continuous for all events within each package in the project.


reloadCSVFile

void reloadCSVFile(java.lang.String fullCSVFileName)
Reloads the content of the specified csv file in a tab in the Output window.

Parameters:
fullCSVFileName - the path of the csv file that should be reloaded

remove

int remove()
Removes the project from the Rhapsody workspace.

Returns:
1 if the project was removed successfully, 0 otherwise
Throws:
RhapsodyRuntimeException

removeCustomViewOnBrowser

void removeCustomViewOnBrowser(IRPPackage customView)
Removes the specified custom view from the model browser.

Parameters:
customView - the custom view that should be removed from the browser
Throws:
RhapsodyRuntimeException

removeCustomViewOnDiagram

void removeCustomViewOnDiagram(IRPDiagram diagram,
                               IRPPackage customView)
Removes the specified custom view from the specified diagram.

Parameters:
diagram - the diagram that the custom view should be removed from
customView - the custom view that should be removed from the diagram
Throws:
RhapsodyRuntimeException

save

void save()
Saves the project.


saveAs

void saveAs(java.lang.String filename)
Saves the project using the specified path.

Parameters:
filename - the path to use for saving the project

saveAsPrevVersion

void saveAsPrevVersion(java.lang.String filename,
                       java.lang.String prevVersion)
Saves the project, using the format of a previous version of Rhapsody.

Parameters:
filename - the path to use for saving the project
prevVersion - the Rhapsody version whose format you want to use for saving the project. The valid strings for this parameter are those that are used in the Save As dialog in the user interface, for example, "7.6.1".

setActiveComponent

void setActiveComponent(java.lang.String name)
Sets the specified component as the active component for the project. Note that there are two versions of this method. The first takes a String parameter, which is the name of the component that should be made the active component. The second version takes an object of type IRPComponent, which is the component that should be made the active component.

Parameters:
activeComponent - the name of the component that should be set as the active component for the project. The string should represent the location of the component in the project hierarchy, using a double colon (::) as the delimiter, for example, Default::subpackage_1::component_a::subcomponent_b. If the component is not contained in a package or within another component, you can just use the name of the component.

setActiveComponent

void setActiveComponent(IRPComponent activeComponent)
Sets the specified component as the active component for the project. Note that there are two versions of this method. The first takes a String parameter, which is the name of the component that should be made the active component. The second version takes an object of type IRPComponent, which is the component that should be made the active component.

Parameters:
activeComponent - the name of the component that should be set as the active component for the project. The string should represent the location of the component in the project hierarchy, using a double colon (::) as the delimiter, for example, Default::subpackage_1::component_a::subcomponent_b. If the component is not contained in a package or within another component, you can just use the name of the component.

setActiveConfiguration

void setActiveConfiguration(java.lang.String name)
Sets the specified configuration to be the active configuration of the project. The configuration must belong to the active component. Note that there are two versions of this method. The first takes a String parameter, which is the name of the configuration that should be made the active configuration. The second version takes an object of type IRPConfiguration, which is the configuration that should be made the active configuration.

Parameters:
activeConfiguration - the name of the configuration to set as the active configuration

setActiveConfiguration

void setActiveConfiguration(IRPConfiguration activeConfiguration)
Sets the specified configuration to be the active configuration of the project. The configuration must belong to the active component. Note that there are two versions of this method. The first takes a String parameter, which is the name of the configuration that should be made the active configuration. The second version takes an object of type IRPConfiguration, which is the configuration that should be made the active configuration.

Parameters:
activeConfiguration - the name of the configuration to set as the active configuration

setDefaultDirectoryScheme

void setDefaultDirectoryScheme(java.lang.String defaultDirectoryScheme)
Set's the project's default directory scheme with regard to packages. This setting is controlled by the property General::Model::DefaultDirectoryScheme.

Parameters:
defaultDirectoryScheme - the default directory scheme to use for packages in the model. The valid values for this parameter are: "Flat" - all new units are saved in a single directory, and "PackageAsDirectory" - a new directory is created for each package in the model.

setNotifyPluginOnElementsChanged

void setNotifyPluginOnElementsChanged(int val)
For plugins that use the callback API, you must call the method setNotifyPluginOnElementsChanged if you want the plugin to be notified when model elements are modified.

Parameters:
val - Use 1 to specify that the plugin should be notified when an element is modified. Use 0 to specify that the plugin should not be notified when elements are modified.
Throws:
RhapsodyRuntimeException

setObjectExplicit

void setObjectExplicit(IRPInstance pInstance)
Changes the specified object to an explicit object. As a result, a class is added to the model with the name [object name]_Class. This method corresponds to the Expose Class option in the pop-up menu of the Rhapsody model browser.

Parameters:
pInstance - the object that should be changed to explicit

setObjectImplicit

void setObjectImplicit(IRPInstance pInstance)
Changes the specified object to an implicit object.

Parameters:
pInstance - the object that should be changed to implicit

setUseUniqueStereotypeAndRefCache

void setUseUniqueStereotypeAndRefCache(int useUniqueStereotypeAndRefCache)
This method can be used to specify that all of the stereotypes in the model should be cached to allow quicker retrieval. This can be beneficial when working with profiles that contain a very large number of stereotypes.

Parameters:
useUniqueStereotypeAndRefCache - use 1 to turn on stereotype caching, use 0 to turn off stereotype caching
Throws:
RhapsodyRuntimeException

setWaitDialogWatchdogValue

void setWaitDialogWatchdogValue(java.lang.String value)
The method setWaitDialogWatchdogValue provides a mechanism that allows an external process to inform Rhapsody that the process has ended or crashed. Call this method with any non-blank value to notify Rhapsody that the process is running. Rhapsody then displays a message dialog indicating that it is waiting for the process to complete. The user plugin must continue calling this method repeatedly to indicate that it has not finished. The interval for calling the function must be less than two minutes. If the method is not called for two minutes, Rhapsody assumes the process has crashed, and it closes the dialog and lets Rhapsody continue. When the process has completed, call the method again with an empty string as the argument. This informs Rhapsody that the process is done.

Parameters:
value - use non-blank string to indicate to Rhapsody that the external process is still running, use blank string to indicate to Rhapsody that the process has completed
Throws:
RhapsodyRuntimeException

startTransactionOfNoCGInterest

void startTransactionOfNoCGInterest()
For internal use only.