|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRPPackage
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 |
Method Detail |
---|
IRPFlowchart addActivityDiagram()
IRPActor addActor(java.lang.String name)
name
- the name to use for the new actor
IRPClass addClass(java.lang.String name)
name
- the name to use for the new class
IRPCollaborationDiagram addCollaborationDiagram(java.lang.String name)
name
- the name to use for the new collaboration diagram
IRPComponentDiagram addComponentDiagram(java.lang.String name)
name
- the name to use for the new component diagram
IRPDeploymentDiagram addDeploymentDiagram(java.lang.String name)
name
- the name to use for the new deployment diagram
IRPEvent addEvent(java.lang.String name)
name
- the name to use for the new event
IRPFlowItem addFlowItems(java.lang.String name)
name
- the name to use for the new item flow
IRPFlow addFlows(java.lang.String name)
name
- the name to use for the new flow
IRPOperation addGlobalFunction(java.lang.String name)
name
- the name to use for the new function
IRPRelation addGlobalObject(java.lang.String name, java.lang.String otherClassName, java.lang.String otherClassPackageName)
name
- the name to use for the new objectotherClassName
- the name of the class that the new object should be an instance ofotherClassPackageName
- 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
IRPAttribute addGlobalVariable(java.lang.String name)
name
- the name to use for the variable
IRPRelation addImplicitObject(java.lang.String name)
name
- the name to use for the new object
IRPLink addLink(IRPInstance fromPart, IRPInstance toPart, IRPRelation assoc, IRPPort fromPort, IRPPort toPort)
fromPart
- the "from" object for the linktoPart
- the "to" object for the linkassoc
- the association that the link should representfromPort
- the "from" port for the linktoPort
- the "to" port for the link
IRPLink addLinkBetweenSYSMLPorts(IRPInstance fromPart, IRPInstance toPart, IRPRelation assoc, IRPSysMLPort fromPort, IRPSysMLPort toPort)
fromPart
- the "from" object for the linktoPart
- the "to" object for the linkassoc
- the association that the link should representfromPort
- the "from" flow port for the linktoPort
- the "to" flow port for the link
RhapsodyRuntimeException
IRPModule addModule(java.lang.String name)
name
- the name to use for the new File
IRPPackage addNestedPackage(java.lang.String name)
name
- the name to use for the new package
IRPNode addNode(java.lang.String name)
name
- the name to use for the new Node element
IRPObjectModelDiagram addObjectModelDiagram(java.lang.String name)
name
- the name to use for the new object model diagram
IRPPanelDiagram addPanelDiagram(java.lang.String name)
name
- the name to use for the new panel diagram
IRPSequenceDiagram addSequenceDiagram(java.lang.String name)
name
- the name to use for the new sequence diagram
IRPStatechart addStatechart()
IRPTimingDiagram addTimingDiagram(java.lang.String name)
name
- the name to use for the new timing diagram
IRPType addType(java.lang.String name)
name
- the name to use for the new type
IRPUseCase addUseCase(java.lang.String name)
name
- the name to use for the new use case
IRPUseCaseDiagram addUseCaseDiagram(java.lang.String name)
name
- the name to use for the new use case diagram
void deleteActor(IRPActor actor)
actor
- that actor that should be deletedvoid deleteClass(IRPClass theClass)
theClass
- the class that should be deletedvoid deleteCollaborationDiagram(java.lang.String name)
name
- the name of the collaboration diagram to deletevoid deleteComponentDiagram(java.lang.String name)
name
- the name of the component diagram to deletevoid deleteDeploymentDiagram(java.lang.String name)
name
- the name of the deployment diagram to deletevoid deleteEvent(IRPEvent event)
event
- the event that should be deletedvoid deleteFlowItems(IRPFlowItem pItem)
pItem
- the item flow that should be deletedvoid deleteFlows(IRPFlow pFlow)
pFlow
- the flow that should be deletedvoid deleteGlobalFunction(IRPOperation operation)
operation
- the global function that should be deletedvoid deleteGlobalObject(IRPRelation relation)
relation
- the object that should be deletedvoid deleteGlobalVariable(IRPAttribute attribute)
attribute
- the global variable that should be deletedvoid deleteNode(java.lang.String name)
name
- the name of the node to deletevoid deleteObjectModelDiagram(java.lang.String name)
name
- the name of the object model diagram to deletevoid deletePackage()
void deletePanelDiagram(java.lang.String name)
name
- the name of the panel diagram to deletevoid deleteSequenceDiagram(java.lang.String name)
name
- the name of the sequence diagram to deletevoid deleteTimingDiagram(java.lang.String name)
name
- the name of the timing diagram to deletevoid deleteType(IRPType type)
type
- the type that should be deletedvoid deleteUseCase(IRPUseCase useCase)
useCase
- the use case that should be deletedvoid deleteUseCaseDiagram(java.lang.String name)
name
- the name of the use case diagram to deleteIRPActor findActor(java.lang.String name)
name
- the name of the actor to return
IRPModelElement findAllByName(java.lang.String name, java.lang.String metaClass)
name
- the name of the element to findmetaClass
- the metaclass of the element to find
IRPClass findClass(java.lang.String name)
name
- the name of the class to return
IRPEvent findEvent(java.lang.String name)
name
- the name of the event to return
IRPOperation findGlobalFunction(java.lang.String name)
name
- the name of the function to return
IRPRelation findGlobalObject(java.lang.String name)
name
- the name of the Object to return
IRPAttribute findGlobalVariable(java.lang.String name)
name
- the name of the variable to return
IRPNode findNode(java.lang.String name)
name
- the name of the node to return
IRPType findType(java.lang.String name)
name
- the name of the type to return
IRPCollection findUsage(IRPModelElement objToFind)
objToFind
- the element whose references you want to find
IRPUseCase findUseCase(java.lang.String name)
name
- the name of the use case to return
IRPCollection getActors()
IRPCollection getAllNestedElements()
IRPCollection getBehavioralDiagrams()
IRPCollection getClasses()
IRPCollection getCollaborationDiagrams()
IRPCollection getComponentDiagrams()
IRPCollection getDeploymentDiagrams()
IRPCollection getEvents()
int getEventsBaseId()
IRPCollection getFlowItems()
IRPCollection getFlows()
IRPCollection getGlobalFunctions()
IRPCollection getGlobalObjects()
IRPCollection getGlobalVariables()
IRPCollection getInstanceSpecifications()
IRPCollection getLinks()
IRPCollection getModules()
java.lang.String getNamespace()
RhapsodyRuntimeException
IRPCollection getNestedClassifiers()
IRPCollection getNestedComponents()
IRPCollection getNodes()
IRPCollection getObjectModelDiagrams()
IRPCollection getPackages()
IRPCollection getPanelDiagrams()
java.lang.String getRemoteRequirementsPopulateMode()
RhapsodyRuntimeException
int getSavedInSeperateDirectory()
IRPCollection getSequenceDiagrams()
IRPCollection getSourceArtifacts()
IRPCollection getTimingDiagrams()
IRPCollection getTypes()
IRPCollection getUseCaseDiagrams()
IRPCollection getUseCases()
IRPCollection getUserDefinedStereotypes()
void populateRemoteRequirements()
int reCalculateEventsBaseId()
void setRemoteRequirementsPopulateMode(java.lang.String populateMode)
populateMode
- can be one of the following values: "All", "Linked", "None"
RhapsodyRuntimeException
void setSavedInSeperateDirectory(int savedInSeperateDirectory)
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |