com.telelogic.rhapsody.core
Interface IRPStateVertex

All Superinterfaces:
IRPModelElement
All Known Subinterfaces:
IRPAcceptEventAction, IRPAcceptTimeEvent, IRPCallOperation, IRPConnector, IRPObjectNode, IRPPin, IRPState

public interface IRPStateVertex
extends IRPModelElement

The IRPStateVertex interface represents the characteristics that are shared by various statechart elements such as states, join/fork connectors, and condition connectors.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPTransition addFlow(java.lang.String type, IRPStateVertex to)
          Adds a control flow or object flow from this element to the specified element.
 IRPTransition addTransition(IRPStateVertex to)
          Adds a transition from this element to the specified element.
 void deleteTransition(IRPTransition transition)
          Deletes the specified transition.
 IRPCollection getInTransitions()
          Returns all of the transitions that enter the element.
 IRPCollection getOutTransitions()
          Returns all of the transitions that exit the element.
 IRPState getParent()
          Returns the element's parent.
 void setParent(IRPState parent)
          Sets the parent state of the element.
 
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

addFlow

IRPTransition addFlow(java.lang.String type,
                      IRPStateVertex to)
Adds a control flow or object flow from this element to the specified element.

Parameters:
type - the type of flow to create - the valid strings that can be used are ControlFlow and ObjectFlow
to - the target element for the new flow
Returns:
the flow created

addTransition

IRPTransition addTransition(IRPStateVertex to)
Adds a transition from this element to the specified element.

Parameters:
to - the target element for the new transition
Returns:
the transition created

deleteTransition

void deleteTransition(IRPTransition transition)
Deletes the specified transition.

Parameters:
transition - the transition to delete

getInTransitions

IRPCollection getInTransitions()
Returns all of the transitions that enter the element. Note that if there are any internal transitions defined, they will also be included in the collection that is returned. If you want to identify which transitions are internal, you can use the method IRPTransition.isStaticReaction().

Returns:
all the transitions that enter the element (collection of IRPTransition elements).

getOutTransitions

IRPCollection getOutTransitions()
Returns all of the transitions that exit the element. Note that if there are any internal transitions defined, they will also be included in the collection that is returned. If you want to identify which transitions are internal, you can use the method IRPTransition.isStaticReaction().

Returns:
all the transitions that exit the element (collection of IRPTransition elements).

getParent

IRPState getParent()
Returns the element's parent. If the element is not contained in a specific state, the root state of the diagram is returned.

Returns:
the element's parent

setParent

void setParent(IRPState parent)
Sets the parent state of the element.

Parameters:
parent - the state that should serve as the parent of the element