com.telelogic.rhapsody.core
Interface IRPPackage

All Superinterfaces:
IRPModelElement, IRPUnit
All Known Subinterfaces:
IRPProfile, IRPProject

public interface IRPPackage
extends IRPUnit

The IRPPackage interface represents packages in Rhapsody models.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPFlowchart addActivityDiagram()
          Adds a new activity diagram to the package.
 IRPActor addActor(java.lang.String name)
          Adds a new actor to the package.
 IRPClass addClass(java.lang.String name)
          Adds a new class to the package.
 IRPCollaborationDiagram addCollaborationDiagram(java.lang.String name)
          Adds a new collaboration diagram to the package.
 IRPComponentDiagram addComponentDiagram(java.lang.String name)
          Adds a new component diagram to the package.
 IRPDeploymentDiagram addDeploymentDiagram(java.lang.String name)
          Adds a new deployment diagram to the package.
 IRPEvent addEvent(java.lang.String name)
          Adds a new event to the package.
 IRPFlowItem addFlowItems(java.lang.String name)
          Adds an item flow to the package.
 IRPFlow addFlows(java.lang.String name)
          Adds a flow to the package.
 IRPOperation addGlobalFunction(java.lang.String name)
          Adds a global function to the package.
 IRPRelation addGlobalObject(java.lang.String name, java.lang.String otherClassName, java.lang.String otherClassPackageName)
          Adds an Object to the package.
 IRPAttribute addGlobalVariable(java.lang.String name)
          Adds a global variable to the package.
 IRPRelation addImplicitObject(java.lang.String name)
          Adds an implicit object to the package.
 IRPLink addLink(IRPInstance fromPart, IRPInstance toPart, IRPRelation assoc, IRPPort fromPort, IRPPort toPort)
          Creates a link between two objects in the package.
 IRPLink addLinkBetweenSYSMLPorts(IRPInstance fromPart, IRPInstance toPart, IRPRelation assoc, IRPSysMLPort fromPort, IRPSysMLPort toPort)
          Creates a link between two objects.
 IRPModule addModule(java.lang.String name)
          Adds a new File element to the package.
 IRPPackage addNestedPackage(java.lang.String name)
          Adds a nested package to the package.
 IRPNode addNode(java.lang.String name)
          Adds a Node element to the package.
 IRPObjectModelDiagram addObjectModelDiagram(java.lang.String name)
          Adds a new object model diagram to the package.
 IRPPanelDiagram addPanelDiagram(java.lang.String name)
          Adds a new panel diagram to the package.
 IRPSequenceDiagram addSequenceDiagram(java.lang.String name)
          Adds a new sequence diagram to the package.
 IRPStatechart addStatechart()
          Adds a new statechart to the package.
 IRPTimingDiagram addTimingDiagram(java.lang.String name)
          Adds a new timing diagram to the package.
 IRPType addType(java.lang.String name)
          Adds a new type to the package.
 IRPUseCase addUseCase(java.lang.String name)
          Adds a new use case to the package.
 IRPUseCaseDiagram addUseCaseDiagram(java.lang.String name)
          Adds a new use case diagram to the package.
 void deleteActor(IRPActor actor)
          Deletes the specified actor.
 void deleteClass(IRPClass theClass)
          Deletes the specified class.
 void deleteCollaborationDiagram(java.lang.String name)
          Deletes the collaboration diagram with the specified name.
 void deleteComponentDiagram(java.lang.String name)
          Deletes the component diagram with the specified name.
 void deleteDeploymentDiagram(java.lang.String name)
          Deletes the deployment diagram with the specified name.
 void deleteEvent(IRPEvent event)
          Deletes the specified event.
 void deleteFlowItems(IRPFlowItem pItem)
          Deletes the specified item flow.
 void deleteFlows(IRPFlow pFlow)
          Deletes the specified flow.
 void deleteGlobalFunction(IRPOperation operation)
          Deletes the specified global function.
 void deleteGlobalObject(IRPRelation relation)
          Deletes the specified object.
 void deleteGlobalVariable(IRPAttribute attribute)
          Deletes the specified global variable.
 void deleteNode(java.lang.String name)
          Deletes the Node element with the specified name.
 void deleteObjectModelDiagram(java.lang.String name)
          Deletes the object model diagram with the specified name.
 void deletePackage()
          Deletes the package.
 void deletePanelDiagram(java.lang.String name)
          Deletes the panel diagram with the specified name.
 void deleteSequenceDiagram(java.lang.String name)
          Deletes the sequence diagram with the specified name.
 void deleteTimingDiagram(java.lang.String name)
          Deletes the timing diagram with the specified name.
 void deleteType(IRPType type)
          Deletes the specified type.
 void deleteUseCase(IRPUseCase useCase)
          Deletes the specified use case.
 void deleteUseCaseDiagram(java.lang.String name)
          Deletes the use case diagram with the specified name.
 IRPActor findActor(java.lang.String name)
          Returns the actor with the specified name.
 IRPModelElement findAllByName(java.lang.String name, java.lang.String metaClass)
          Searches the package for a model element of the specified type with the specified name.
 IRPClass findClass(java.lang.String name)
          Returns the class with the specified name.
 IRPEvent findEvent(java.lang.String name)
          Returns the event with the specified name.
 IRPOperation findGlobalFunction(java.lang.String name)
          Returns the global function with the specified name.
 IRPRelation findGlobalObject(java.lang.String name)
          Returns the Object with the specified name.
 IRPAttribute findGlobalVariable(java.lang.String name)
          Returns the global variable with the specified name.
 IRPNode findNode(java.lang.String name)
          Returns the Node element with the specified name.
 IRPType findType(java.lang.String name)
          Returns the type with the specified name.
 IRPCollection findUsage(IRPModelElement objToFind)
          Returns a collection of the elements in the current package that are related to the specified model element.
 IRPUseCase findUseCase(java.lang.String name)
          Returns the use case with the specified name.
 IRPCollection getActors()
          Returns a collection of all the actors in the package.
 IRPCollection getAllNestedElements()
          Returns a collection of all the model elements that are directly under the current package, including functions, global variables, and global objects.
 IRPCollection getBehavioralDiagrams()
          Returns a collection of all the activity diagrams in the package.
 IRPCollection getClasses()
          Returns a collection of all the classes in the package.
 IRPCollection getCollaborationDiagrams()
          Returns a collection of all the collaboration diagrams in the package.
 IRPCollection getComponentDiagrams()
          Returns a collection of all the component diagrams in the package.
 IRPCollection getDeploymentDiagrams()
          Returns a collection of all the deployment diagrams in the package.
 IRPCollection getEvents()
          Returns a collection of all the events in the package.
 int getEventsBaseId()
          Returns the start number used for assigning IDs to events in the package.
 IRPCollection getFlowItems()
          Returns a collection of all the item flows in the package.
 IRPCollection getFlows()
          Returns a collection of all the flows in the package.
 IRPCollection getGlobalFunctions()
          Returns a collection of all the global functions in the package.
 IRPCollection getGlobalObjects()
          Returns a collection of all the Objects in the package.
 IRPCollection getGlobalVariables()
          Returns a collection of all the global variables in the package.
 IRPCollection getInstanceSpecifications()
          Returns a collection of all the instance specifications in the package.
 IRPCollection getLinks()
          Returns a collection of all the Links in the package.
 IRPCollection getModules()
          Returns a collection of all the File elements in the package.
 java.lang.String getNamespace()
          getNamespace
 IRPCollection getNestedClassifiers()
          Returns a collection of all the classifiers in the package.
 IRPCollection getNestedComponents()
          Returns a collection of all the Components in the package.
 IRPCollection getNodes()
          Returns a collection of all the Node elements in the package.
 IRPCollection getObjectModelDiagrams()
          Returns a collection of all the object model diagrams in the package.
 IRPCollection getPackages()
          Returns a collection of all the nested packages in the package.
 IRPCollection getPanelDiagrams()
          Returns a collection of all the panel diagrams in the package.
 java.lang.String getRemoteRequirementsPopulateMode()
          Returns the mode that was selected for loading remote requirements in the collection.
 int getSavedInSeperateDirectory()
          Checks whether the package is configured to be saved in a separate directory.
 IRPCollection getSequenceDiagrams()
          Returns a collection of all the sequence diagrams in the package.
 IRPCollection getSourceArtifacts()
          Gets the source artifacts for the package.
 IRPCollection getTimingDiagrams()
          Returns a collection of all the timing diagrams in the package.
 IRPCollection getTypes()
          Returns a collection of all the types in the package.
 IRPCollection getUseCaseDiagrams()
          Returns a collection of all the use case diagrams in the package.
 IRPCollection getUseCases()
          Returns a collection of all the use cases in the package.
 IRPCollection getUserDefinedStereotypes()
          Returns a collection of all the user-defined stereotypes in the package.
 void populateRemoteRequirements()
          For Design Manager projects, populates the package with the remote requirements that model elements do not yet have dependencies upon.
 int reCalculateEventsBaseId()
          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 setRemoteRequirementsPopulateMode(java.lang.String populateMode)
          For collections of remote requirements, you can use setRemoteRequirementsPopulateMode to specify which requirements in the collection should be loaded when you open the model - all the requirements, only the requirements that have OSLC links to model elements, or none of the requirements.
 void setSavedInSeperateDirectory(int savedInSeperateDirectory)
          Specifies whether the package should be saved in a separate directory.
 
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

addActivityDiagram

IRPFlowchart addActivityDiagram()
Adds a new activity diagram to the package.

Returns:
the activity diagram that was created

addActor

IRPActor addActor(java.lang.String name)
Adds a new actor to the package.

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

addClass

IRPClass addClass(java.lang.String name)
Adds a new class to the package.

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

addCollaborationDiagram

IRPCollaborationDiagram addCollaborationDiagram(java.lang.String name)
Adds a new collaboration diagram to the package.

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

addComponentDiagram

IRPComponentDiagram addComponentDiagram(java.lang.String name)
Adds a new component diagram to the package.

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

addDeploymentDiagram

IRPDeploymentDiagram addDeploymentDiagram(java.lang.String name)
Adds a new deployment diagram to the package.

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

addEvent

IRPEvent addEvent(java.lang.String name)
Adds a new event to the package.

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

addFlowItems

IRPFlowItem addFlowItems(java.lang.String name)
Adds an item flow to the package.

Parameters:
name - the name to use for the new item flow
Returns:
the item flow created

addFlows

IRPFlow addFlows(java.lang.String name)
Adds a flow to the package.

Parameters:
name - the name to use for the new flow
Returns:
the flow created

addGlobalFunction

IRPOperation addGlobalFunction(java.lang.String name)
Adds a global function to the package.

Parameters:
name - the name to use for the new function
Returns:
the function created

addGlobalObject

IRPRelation addGlobalObject(java.lang.String name,
                            java.lang.String otherClassName,
                            java.lang.String otherClassPackageName)
Adds an Object to the package. This method is for adding instances of existing classes. To add an implicit object, use the method addImplicitObject.

Parameters:
name - the name to use for the new object
otherClassName - the name of the class that the new object should be an instance of
otherClassPackageName - the name of the package that contains the class. You must specify this argument even if you are adding the object to the package that contains the class you are instantiating
Returns:
the object that was created

addGlobalVariable

IRPAttribute addGlobalVariable(java.lang.String name)
Adds a global variable to the package.

Parameters:
name - the name to use for the variable
Returns:
the variable created

addImplicitObject

IRPRelation addImplicitObject(java.lang.String name)
Adds an implicit object to the package. This is relevant only for C and C++ models.

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

addLink

IRPLink addLink(IRPInstance fromPart,
                IRPInstance toPart,
                IRPRelation assoc,
                IRPPort fromPort,
                IRPPort toPort)
Creates a link between two objects in the package. In addition to specifying the two objects, 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:
fromPart - the "from" object for the link
toPart - the "to" object for the link
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

addLinkBetweenSYSMLPorts

IRPLink addLinkBetweenSYSMLPorts(IRPInstance fromPart,
                                 IRPInstance toPart,
                                 IRPRelation assoc,
                                 IRPSysMLPort fromPort,
                                 IRPSysMLPort toPort)
Creates a link between two objects. In addition to specifying the two objects, you must specify the association that the link should represent, or, alternatively, the two flow ports that should be used for the link. If you provide the two flow ports as arguments, you should use Null for the association argument. Similarly, if you specify an association, you should use Null for the two flow port arguments. Note that if you are not specifying the two flow ports, you must provide an association as an argument even if there is only one relevant association.

Parameters:
fromPart - the "from" object for the link
toPart - the "to" object for the link
assoc - the association that the link should represent
fromPort - the "from" flow port for the link
toPort - the "to" flow port for the link
Returns:
the link created
Throws:
RhapsodyRuntimeException

addModule

IRPModule addModule(java.lang.String name)
Adds a new File element to the package.

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

addNestedPackage

IRPPackage addNestedPackage(java.lang.String name)
Adds a nested package to the package.

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

addNode

IRPNode addNode(java.lang.String name)
Adds a Node element to the package.

Parameters:
name - the name to use for the new Node element
Returns:
the Node element created

addObjectModelDiagram

IRPObjectModelDiagram addObjectModelDiagram(java.lang.String name)
Adds a new object model diagram to the package.

Parameters:
name - the name to use for the new object model diagram
Returns:
the object model diagram that was created

addPanelDiagram

IRPPanelDiagram addPanelDiagram(java.lang.String name)
Adds a new panel diagram to the package.

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

addSequenceDiagram

IRPSequenceDiagram addSequenceDiagram(java.lang.String name)
Adds a new sequence diagram to the package.

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

addStatechart

IRPStatechart addStatechart()
Adds a new statechart to the package.

Returns:
the statechart that was created

addTimingDiagram

IRPTimingDiagram addTimingDiagram(java.lang.String name)
Adds a new timing diagram to the package.

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

addType

IRPType addType(java.lang.String name)
Adds a new type to the package.

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

addUseCase

IRPUseCase addUseCase(java.lang.String name)
Adds a new use case to the package.

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

addUseCaseDiagram

IRPUseCaseDiagram addUseCaseDiagram(java.lang.String name)
Adds a new use case diagram to the package.

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

deleteActor

void deleteActor(IRPActor actor)
Deletes the specified actor.

Parameters:
actor - that actor that should be deleted

deleteClass

void deleteClass(IRPClass theClass)
Deletes the specified class.

Parameters:
theClass - the class that should be deleted

deleteCollaborationDiagram

void deleteCollaborationDiagram(java.lang.String name)
Deletes the collaboration diagram with the specified name.

Parameters:
name - the name of the collaboration diagram to delete

deleteComponentDiagram

void deleteComponentDiagram(java.lang.String name)
Deletes the component diagram with the specified name.

Parameters:
name - the name of the component diagram to delete

deleteDeploymentDiagram

void deleteDeploymentDiagram(java.lang.String name)
Deletes the deployment diagram with the specified name.

Parameters:
name - the name of the deployment diagram to delete

deleteEvent

void deleteEvent(IRPEvent event)
Deletes the specified event.

Parameters:
event - the event that should be deleted

deleteFlowItems

void deleteFlowItems(IRPFlowItem pItem)
Deletes the specified item flow.

Parameters:
pItem - the item flow that should be deleted

deleteFlows

void deleteFlows(IRPFlow pFlow)
Deletes the specified flow.

Parameters:
pFlow - the flow that should be deleted

deleteGlobalFunction

void deleteGlobalFunction(IRPOperation operation)
Deletes the specified global function.

Parameters:
operation - the global function that should be deleted

deleteGlobalObject

void deleteGlobalObject(IRPRelation relation)
Deletes the specified object.

Parameters:
relation - the object that should be deleted

deleteGlobalVariable

void deleteGlobalVariable(IRPAttribute attribute)
Deletes the specified global variable.

Parameters:
attribute - the global variable that should be deleted

deleteNode

void deleteNode(java.lang.String name)
Deletes the Node element with the specified name.

Parameters:
name - the name of the node to delete

deleteObjectModelDiagram

void deleteObjectModelDiagram(java.lang.String name)
Deletes the object model diagram with the specified name.

Parameters:
name - the name of the object model diagram to delete

deletePackage

void deletePackage()
Deletes the package.


deletePanelDiagram

void deletePanelDiagram(java.lang.String name)
Deletes the panel diagram with the specified name.

Parameters:
name - the name of the panel diagram to delete

deleteSequenceDiagram

void deleteSequenceDiagram(java.lang.String name)
Deletes the sequence diagram with the specified name.

Parameters:
name - the name of the sequence diagram to delete

deleteTimingDiagram

void deleteTimingDiagram(java.lang.String name)
Deletes the timing diagram with the specified name.

Parameters:
name - the name of the timing diagram to delete

deleteType

void deleteType(IRPType type)
Deletes the specified type.

Parameters:
type - the type that should be deleted

deleteUseCase

void deleteUseCase(IRPUseCase useCase)
Deletes the specified use case.

Parameters:
useCase - the use case that should be deleted

deleteUseCaseDiagram

void deleteUseCaseDiagram(java.lang.String name)
Deletes the use case diagram with the specified name.

Parameters:
name - the name of the use case diagram to delete

findActor

IRPActor findActor(java.lang.String name)
Returns the actor with the specified name.

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

findAllByName

IRPModelElement findAllByName(java.lang.String name,
                              java.lang.String metaClass)
Searches the package for a model element of the specified type with the specified name. Note that the search is carried out recursively if the package contains nested packages. In cases where there are multiple elements that meet the search criteria, the first such element encountered will be returned.

Parameters:
name - the name of the element to find
metaClass - the metaclass of the element to find
Returns:
the first element found that satisfies the search criteria

findClass

IRPClass findClass(java.lang.String name)
Returns the class with the specified name.

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

findEvent

IRPEvent findEvent(java.lang.String name)
Returns the event with the specified name.

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

findGlobalFunction

IRPOperation findGlobalFunction(java.lang.String name)
Returns the global function with the specified name.

Parameters:
name - the name of the function to return
Returns:
the global function with the specified name

findGlobalObject

IRPRelation findGlobalObject(java.lang.String name)
Returns the Object with the specified name.

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

findGlobalVariable

IRPAttribute findGlobalVariable(java.lang.String name)
Returns the global variable with the specified name.

Parameters:
name - the name of the variable to return
Returns:
the global variable with the specified name

findNode

IRPNode findNode(java.lang.String name)
Returns the Node element with the specified name.

Parameters:
name - the name of the node to return
Returns:
the Node element with the specified name

findType

IRPType findType(java.lang.String name)
Returns the type with the specified name.

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

findUsage

IRPCollection findUsage(IRPModelElement objToFind)
Returns a collection of the elements in the current package that are related to the specified model element. Note that the type of relations searched for depends upon the type of the element specified. For a more comprehensive list of references to the element, use the method IRPModelElement.getReferences(). (Keep in mind that getReferences() searches the entire model, not just the current package.)

Parameters:
objToFind - the element whose references you want to find
Returns:
the elements in the current package that are related to the specified model element

findUseCase

IRPUseCase findUseCase(java.lang.String name)
Returns the use case with the specified name.

Parameters:
name - the name of the use case to return
Returns:
the use case with the specified name

getActors

IRPCollection getActors()
Returns a collection of all the actors in the package.

Returns:
all the actors in the package

getAllNestedElements

IRPCollection getAllNestedElements()
Returns a collection of all the model elements that are directly under the current package, including functions, global variables, and global objects.

Returns:
collection of all the model elements that are directly under the current package, including functions, global variables, and global objects

getBehavioralDiagrams

IRPCollection getBehavioralDiagrams()
Returns a collection of all the activity diagrams in the package. Note that this includes only the activity diagrams directly under the package, not diagrams belonging to classes in the package.

Returns:
all the activity diagrams directly under the package

getClasses

IRPCollection getClasses()
Returns a collection of all the classes in the package.

Returns:
all the classes in the package

getCollaborationDiagrams

IRPCollection getCollaborationDiagrams()
Returns a collection of all the collaboration diagrams in the package.

Returns:
all the collaboration diagrams in the package

getComponentDiagrams

IRPCollection getComponentDiagrams()
Returns a collection of all the component diagrams in the package.

Returns:
all the component diagrams in the package

getDeploymentDiagrams

IRPCollection getDeploymentDiagrams()
Returns a collection of all the deployment diagrams in the package.

Returns:
all the deployment diagrams in the package

getEvents

IRPCollection getEvents()
Returns a collection of all the events in the package.

Returns:
all the events in the package

getEventsBaseId

int getEventsBaseId()
Returns the start number used for assigning IDs to events in the package. This value is controlled by the property EventsBaseID.

Returns:
the start number used for assigning IDs to events in the package

getFlowItems

IRPCollection getFlowItems()
Returns a collection of all the item flows in the package.

Returns:
all the item flows in the package

getFlows

IRPCollection getFlows()
Returns a collection of all the flows in the package.

Returns:
all the flows in the package

getGlobalFunctions

IRPCollection getGlobalFunctions()
Returns a collection of all the global functions in the package.

Returns:
all the global functions in the package

getGlobalObjects

IRPCollection getGlobalObjects()
Returns a collection of all the Objects in the package.

Returns:
all the Objects in the package

getGlobalVariables

IRPCollection getGlobalVariables()
Returns a collection of all the global variables in the package.

Returns:
all the global variables in the package

getInstanceSpecifications

IRPCollection getInstanceSpecifications()
Returns a collection of all the instance specifications in the package.

Returns:
all the instance specifications in the package

getLinks

IRPCollection getLinks()
Returns a collection of all the Links in the package.

Returns:
all the Links in the package

getModules

IRPCollection getModules()
Returns a collection of all the File elements in the package.

Returns:
all the File elements in the package

getNamespace

java.lang.String getNamespace()
getNamespace

Throws:
RhapsodyRuntimeException

getNestedClassifiers

IRPCollection getNestedClassifiers()
Returns a collection of all the classifiers in the package.

Returns:
all the classifiers in the package

getNestedComponents

IRPCollection getNestedComponents()
Returns a collection of all the Components in the package.

Returns:
all the Components in the package

getNodes

IRPCollection getNodes()
Returns a collection of all the Node elements in the package.

Returns:
all the Node elements in the package

getObjectModelDiagrams

IRPCollection getObjectModelDiagrams()
Returns a collection of all the object model diagrams in the package.

Returns:
all the object model diagrams in the package

getPackages

IRPCollection getPackages()
Returns a collection of all the nested packages in the package.

Returns:
all the nested packages in the package

getPanelDiagrams

IRPCollection getPanelDiagrams()
Returns a collection of all the panel diagrams in the package.

Returns:
all the panel diagrams in the package

getRemoteRequirementsPopulateMode

java.lang.String getRemoteRequirementsPopulateMode()
Returns the mode that was selected for loading remote requirements in the collection.

Returns:
the mode that was selected for loading remote requirements in the collection - will be one of the following values: "All", "Linked", "None"
Throws:
RhapsodyRuntimeException

getSavedInSeperateDirectory

int getSavedInSeperateDirectory()
Checks whether the package is configured to be saved in a separate directory.

Returns:
1 if the package is configured to be saved in a separate directory, 0 otherwise

getSequenceDiagrams

IRPCollection getSequenceDiagrams()
Returns a collection of all the sequence diagrams in the package.

Returns:
all the sequence diagrams in the package

getSourceArtifacts

IRPCollection getSourceArtifacts()
Gets the source artifacts for the package.

Returns:
the source artifacts for the package, as a collection of IRPFile objects

getTimingDiagrams

IRPCollection getTimingDiagrams()
Returns a collection of all the timing diagrams in the package.

Returns:
all the timing diagrams in the package

getTypes

IRPCollection getTypes()
Returns a collection of all the types in the package.

Returns:
all the types in the package

getUseCaseDiagrams

IRPCollection getUseCaseDiagrams()
Returns a collection of all the use case diagrams in the package.

Returns:
all the use case diagrams in the package

getUseCases

IRPCollection getUseCases()
Returns a collection of all the use cases in the package.

Returns:
all the use cases in the package

getUserDefinedStereotypes

IRPCollection getUserDefinedStereotypes()
Returns a collection of all the user-defined stereotypes in the package.

Returns:
all the user-defined stereotypes in the package

populateRemoteRequirements

void populateRemoteRequirements()
For Design Manager projects, populates the package with the remote requirements that model elements do not yet have dependencies upon. This method corresponds to the "populate with all existing requirements" option that the UI provides for "Remote Resource" packages. Once these requirements have been added to the package, you can add dependencies to these requirements by using the "link to remote requirement" option.


reCalculateEventsBaseId

int reCalculateEventsBaseId()
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 reCalculateEventsBaseId to have the event ID numbering recalculated so that event IDs are continuous for all events in the package.

Returns:
the new start number for event IDs in the package

setRemoteRequirementsPopulateMode

void setRemoteRequirementsPopulateMode(java.lang.String populateMode)
For collections of remote requirements, you can use setRemoteRequirementsPopulateMode to specify which requirements in the collection should be loaded when you open the model - all the requirements, only the requirements that have OSLC links to model elements, or none of the requirements.

Parameters:
populateMode - can be one of the following values: "All", "Linked", "None"
Throws:
RhapsodyRuntimeException

setSavedInSeperateDirectory

void setSavedInSeperateDirectory(int savedInSeperateDirectory)
Specifies whether the package should be saved in a separate directory.

Parameters:
savedInSeperateDirectory - Use 1 to specify that the package should be saved in a separate directory. Use 0 to specify that the package should not be saved in a separate directory.