com.telelogic.rhapsody.core
Interface IRPFlowchart

All Superinterfaces:
IRPClass, IRPClassifier, IRPModelElement, IRPStatechart, IRPUnit

public interface IRPFlowchart
extends IRPStatechart

The IRPFlowchart interface represents activities in Rational Rhapsody models.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPAcceptEventAction addAcceptEventAction(java.lang.String name, IRPState parent)
          Adds a new Accept Event Action element to the activity.
 IRPAcceptTimeEvent addAcceptTimeEvent(java.lang.String name, IRPState parent)
          Adds a new Accept Time Event element to the activity.
 IRPPin addActivityParameter(java.lang.String name)
          Adds an activity parameter to the frame of the activity
 IRPState addCallBehavior(IRPModelElement referenced)
          Adds a new Call Behavior element to the activity.
 IRPCallOperation addCallOperation(java.lang.String name, IRPState parent)
          Adds a new Call Operation element to the activity.
 IRPObjectNode addObjectNode(java.lang.String name, IRPState parent)
          Adds a new Object Node element to the activity.
 IRPState addReferenceActivity(IRPModelElement referenced)
          Adds a new Call Behavior element to the activity.
 IRPSwimlane addSwimlane(java.lang.String name)
          Adds a new swimlane to the activity.
 IRPActivityDiagram getFlowchartDiagram()
          Returns the IRPActivityDiagram object associated with the activity.
 int getIsAnalysisOnly()
          Checks whether the activity is defined as analysis-only, meaning that it is used only for modeling purposes and code is not generated for the activity.
 IRPOperation getItsOwner()
          Deprecated. Use IRPModelElement.getOwner instead.
 IRPCollection getSwimlanes()
          Returns a collection of all the swimlanes in the activity.
 void setIsAnalysisOnly(int isAnalysisOnly)
          Specifies whether the activity should be defined as analysis-only.
 void setItsOwner(IRPOperation itsOwner)
          Deprecated. Use IRPModelElement.setOwner instead.
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPStatechart
addFreeShapeByType, addImage, addNewEdgeByType, addNewEdgeForElement, addNewNodeByType, addNewNodeForElement, addTextBox, closeDiagram, createGraphics, deleteState, findTrigger, getAllTriggers, getElementsInDiagram, getGraphicalElements, getInheritsFrom, getIsMainBehavior, getIsOverridden, getItsClass, getPicture, getPictureAs, getPictureAsDividedMetafiles, getPicturesWithImageMap, getRootState, getStatechartDiagram, openDiagramView, overrideInheritance, populateDiagram, setAsMainBehavior, setShowDiagramFrame, unoverrideInheritance
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPClass
addClass, addConstructor, addDestructor, addEventReception, addLink, addLinkToPartViaPort, addReception, addSuperclass, addTriggeredOperation, addType, deleteClass, deleteConstructor, deleteDestructor, deleteEventReception, deleteReception, deleteSuperclass, deleteType, getIsAbstract, getIsActive, getIsBehaviorOverriden, getIsComposite, getIsFinal, getIsReactive, setIsAbstract, setIsActive, setIsBehaviorOverriden, setIsFinal
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPClassifier
addActivityDiagram, addAttribute, addFlowItems, addFlows, addGeneralization, addOperation, addRelation, addRelationTo, addStatechart, addUnidirectionalRelation, addUnidirectionalRelationTo, deleteAttribute, deleteFlowItems, deleteFlows, deleteGeneralization, deleteOperation, deleteRelation, findAttribute, findBaseClassifier, findDerivedClassifier, findGeneralization, findInterfaceItem, findNestedClassifier, findNestedClassifierRecursive, findRelation, findTrigger, getActivityDiagram, getAttributes, getAttributesIncludingBases, getBaseClassifiers, getBehavioralDiagrams, getDerivedClassifiers, getFlowItems, getFlows, getGeneralizations, getInterfaceItems, getInterfaceItemsIncludingBases, getLinks, getNestedClassifiers, getOperations, getPorts, getRelations, getRelationsIncludingBases, getSequenceDiagrams, getSourceArtifacts, getStatechart
 
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

addAcceptEventAction

IRPAcceptEventAction addAcceptEventAction(java.lang.String name,
                                          IRPState parent)
Adds a new Accept Event Action element to the activity.

Parameters:
name - the name to use for the new Accept Event Action element
parent - the diagram element to which the new Accept Event Action element should be added. If the Accept Event Action element is being added to an Action Block, this parameter should be the Action Block. Otherwise, it should be the root state of the diagram (which is obtained by calling IRPStatechart.getRootState()).
Returns:
the Accept Event Action element that was created

addAcceptTimeEvent

IRPAcceptTimeEvent addAcceptTimeEvent(java.lang.String name,
                                      IRPState parent)
Adds a new Accept Time Event element to the activity.

Parameters:
name - the name to use for the new Accept Time Event element
parent - the diagram element to which the new Accept Time Event element should be added. If the Accept Time Event element is being added to an Action Block, this parameter should be the Action Block. Otherwise, it should be the root state of the diagram (which is obtained by calling IRPStatechart.getRootState()).
Returns:
the Accept Time Event element that was created

addActivityParameter

IRPPin addActivityParameter(java.lang.String name)
Adds an activity parameter to the frame of the activity

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

addCallBehavior

IRPState addCallBehavior(IRPModelElement referenced)
Adds a new Call Behavior element to the activity.

Parameters:
referenced - the activity that the new Call Behavior element should invoke
Returns:
the Call Behavior element that was created

addCallOperation

IRPCallOperation addCallOperation(java.lang.String name,
                                  IRPState parent)
Adds a new Call Operation element to the activity.

Parameters:
name - the name to use for the new Call Operation element
parent - the diagram element to which the new Call Operation element should be added. If the Call Operation element is being added to an Action Block, this parameter should be the Action Block. Otherwise, it should be the root state of the diagram (which is obtained by calling IRPStatechart.getRootState()).
Returns:
the Call Operation element that was created

addObjectNode

IRPObjectNode addObjectNode(java.lang.String name,
                            IRPState parent)
Adds a new Object Node element to the activity.

Parameters:
name - the name to use for the new Object Node element
parent - the diagram element to which the new Object Node element should be added. If the Object Node element is being added to an Action Block, this parameter should be the Action Block. Otherwise, it should be the root state of the diagram (which is obtained by calling IRPStatechart.getRootState()).
Returns:
the Object Node element that was created

addReferenceActivity

IRPState addReferenceActivity(IRPModelElement referenced)
Adds a new Call Behavior element to the activity. Performs same action as the addCallBehavior method.

Parameters:
referenced - the activity that the new Call Behavior element should invoke
Returns:
the Call Behavior element that was created

addSwimlane

IRPSwimlane addSwimlane(java.lang.String name)
Adds a new swimlane to the activity.

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

getFlowchartDiagram

IRPActivityDiagram getFlowchartDiagram()
Returns the IRPActivityDiagram object associated with the activity.

Returns:
the IRPActivityDiagram object associated with the activity

getIsAnalysisOnly

int getIsAnalysisOnly()
Checks whether the activity is defined as analysis-only, meaning that it is used only for modeling purposes and code is not generated for the activity.

Returns:
1 if the activity is defined as analysis-only, 0 otherwise

getItsOwner

IRPOperation getItsOwner()
Deprecated. Use IRPModelElement.getOwner instead.


getSwimlanes

IRPCollection getSwimlanes()
Returns a collection of all the swimlanes in the activity.

Returns:
collection of IRPSwimlane objects

setIsAnalysisOnly

void setIsAnalysisOnly(int isAnalysisOnly)
Specifies whether the activity should be defined as analysis-only.

Parameters:
isAnalysisOnly - Use 1 to specify that the activity should be defined as analysis-only. Use 0 to specify that the activity should not be defined as analysis-only.

setItsOwner

void setItsOwner(IRPOperation itsOwner)
Deprecated. Use IRPModelElement.setOwner instead.