|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRPProject
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.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 |
Method Detail |
---|
void gatewayExportToXML(java.lang.String filename, java.lang.String params)
void gatewayExportToXML2(java.lang.String filename, java.lang.String params, IRPProject proj)
void generateReport(java.lang.String modelscope, java.lang.String templatename, java.lang.String docType, java.lang.String filename, int showDocument, int silentMode)
// Sample code: IRPProject currentProject = app.activeProject(); currentProject.generateReport("", "C:\Rhapsody\reporterplus\Templates\Class.tpl", "html", "C:\testreport.html", 0, 0);
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.)IRPComponent addComponent(java.lang.String name)
name
- the name to use for the new Component
void addCustomViewOnBrowser(IRPPackage customView)
customView
- the custom view that should be applied to the browser
RhapsodyRuntimeException
void addCustomViewOnDiagram(IRPDiagram diagram, IRPPackage customView)
diagram
- the diagram to which the custom view should be appliedcustomView
- the custom view that should be applied to the diagram
RhapsodyRuntimeException
IRPPackage addPackage(java.lang.String name)
name
- the name to use for the new package
IRPProfile addProfile(java.lang.String name)
name
- the name to use for the new profile
void addSpellCheckerResult(java.lang.String value)
void allowAutoSave(int allow)
allow
- Use 0 to turn off autosave, use 1 to turn autosave onvoid allowNonUniqueNames(int allow)
void applyBrowserCustomViewsOnDiagrams(int newVal)
newVal
- Use 1 to apply the custom views to all diagrams, 0 to remove the custom views from the diagrams
RhapsodyRuntimeException
void applyRoundtripDiffMerge(int magicNumber, IRPProject shadowModel, IRPCollection filesToUpdate)
void becomeActiveProject()
void checkEventsBaseIdsSolveCollisions()
void cleanUnresolvedElements(IRPModelElement rootElement)
rootElement
- the element below which Rhapsody should remove all unresolved elementsvoid close()
void closeCSVFile(java.lang.String fullCSVFileName)
fullCSVFileName
- the path of the csv file that should be closedvoid deleteComponent(IRPComponent component)
component
- the Component that should be deletedvoid endTransactionOfNoCGInterest()
IRPComponent findComponent(java.lang.String name)
name
- the name of the Component to return
IRPModelElement findElementByBinaryID(byte[] theID)
theID
- the binary ID for the model element that should be retrieved
IRPModelElement findElementByFileName(java.lang.String theFolderName, java.lang.String theFileName)
theFolderName
- the full path of the folder that contains the unit filetheFileName
- the filename for the unit file
RhapsodyRuntimeException
IRPModelElement findElementByGUID(java.lang.String theGUID)
theGUID
- the GUID for the model element that should be retrieved
IRPCollection findElementsWithOSLCLink(java.lang.String type, java.lang.String purl)
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.
RhapsodyRuntimeException
IRPComponent getActiveComponent()
IRPConfiguration getActiveConfiguration()
IRPCollection getActiveCustomViewsOnBrowser()
RhapsodyRuntimeException
IRPCollection getActiveCustomViewsOnDiagram(IRPDiagram diagram)
diagram
- the diagram whose custom views should be returned
RhapsodyRuntimeException
IRPCollection getAllStereotypes()
IRPPackage getCgSimplifiedModelPackage()
IRPCollection getCodeGeneratedFiles()
IRPCollection getComponents()
java.lang.String getDefaultDirectoryScheme()
IRPCollaboration getNewCollaboration()
IRPProgressBar getNewProgressBar(int amount, java.lang.String name)
RhapsodyRuntimeException
int getNotifyPluginOnElementsChanged()
RhapsodyRuntimeException
IRPCollection getProfiles()
IRPCollection getRemoteResourcePackages()
IRPCollection getRequirementsByID(java.lang.String requirementID, int returnFirstFoundOnly)
requirementID
- the ID to use for the searchreturnFirstFoundOnly
- 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
RhapsodyRuntimeException
IRPProject getRoundtripShadowModel(int magicNumber)
IRPModelElement highlightFromCode(java.lang.String filename, int lineNumber)
IRPProject prj = app.openProject("d:\\temp\\_sample_code\\First_Project.rpy");
prj.highlightFromCode("d:\\temp\\_sample_code\\DefaultComponent\\DefaultConfig\\class_0.h", 42);
filename
- the absolute path for the relevant source filelineNumber
- the line number in the file
RhapsodyRuntimeException
void importPackageFromRose(java.lang.String projectName, java.lang.String packageName, java.lang.String logFileName)
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 importlogFileName
- the file to use for logging the import processvoid importProjectFromRose(java.lang.String projectName, java.lang.String logFileName)
projectName
- the Rose project to import (path that includes the name of the *.mdl file)logFileName
- the file to use for logging the import processint isActivelyManaged()
RhapsodyRuntimeException
int isModifiedRecursive()
void locateInIDE(IRPConfiguration config, java.lang.String filename, int lineNumber)
config
- the Rhapsody configuration (of type Eclipse or Visual Studio configuration) that contains the generated source filefilename
- the name of the file that should be opened in the IDElineNumber
- the line number of the line that should be highlighted
RhapsodyRuntimeException
void moveToDesignManager(java.lang.String userName, java.lang.String password, java.lang.String serverURL, java.lang.String projectAreaName, java.lang.String streamName)
userName
- the username for logging in to the Design Manager serverpassword
- the password for logging in to the Design Manager serverserverURL
- the URL of the Design Manager serverprojectAreaName
- the name of the Project Area to use for this modelstreamName
- the name of the Stream to use for this modelvoid moveToDesignManagerAfterLogin(java.lang.String serverURL, java.lang.String projectAreaName, java.lang.String streamName)
serverURL
- the URL of the Design Manager serverprojectAreaName
- the name of the Project Area to use for this modelstreamName
- the name of the Stream to use for this model
RhapsodyRuntimeException
void openCSVFile(java.lang.String fullCSVFileName, int reserved)
fullCSVFileName
- the path of the csv file that should be displayedreserved
- this parameter has no effect, you can use any integervoid recalculateEventsBaseIds()
void reloadCSVFile(java.lang.String fullCSVFileName)
fullCSVFileName
- the path of the csv file that should be reloadedint remove()
RhapsodyRuntimeException
void removeCustomViewOnBrowser(IRPPackage customView)
customView
- the custom view that should be removed from the browser
RhapsodyRuntimeException
void removeCustomViewOnDiagram(IRPDiagram diagram, IRPPackage customView)
diagram
- the diagram that the custom view should be removed fromcustomView
- the custom view that should be removed from the diagram
RhapsodyRuntimeException
void save()
void saveAs(java.lang.String filename)
filename
- the path to use for saving the projectvoid saveAsPrevVersion(java.lang.String filename, java.lang.String prevVersion)
filename
- the path to use for saving the projectprevVersion
- 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".void setActiveComponent(java.lang.String name)
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.void setActiveComponent(IRPComponent activeComponent)
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.void setActiveConfiguration(java.lang.String name)
activeConfiguration
- the name of the configuration to set as the active configurationvoid setActiveConfiguration(IRPConfiguration activeConfiguration)
activeConfiguration
- the name of the configuration to set as the active configurationvoid setDefaultDirectoryScheme(java.lang.String defaultDirectoryScheme)
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.void setNotifyPluginOnElementsChanged(int val)
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.
RhapsodyRuntimeException
void setObjectExplicit(IRPInstance pInstance)
pInstance
- the object that should be changed to explicitvoid setObjectImplicit(IRPInstance pInstance)
pInstance
- the object that should be changed to implicitvoid setUseUniqueStereotypeAndRefCache(int useUniqueStereotypeAndRefCache)
useUniqueStereotypeAndRefCache
- use 1 to turn on stereotype caching, use 0 to turn off stereotype caching
RhapsodyRuntimeException
void setWaitDialogWatchdogValue(java.lang.String value)
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
RhapsodyRuntimeException
void startTransactionOfNoCGInterest()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |