com.telelogic.rhapsody.core
Interface IRPConnector

All Superinterfaces:
IRPModelElement, IRPStateVertex
All Known Subinterfaces:
IRPPin

public interface IRPConnector
extends IRPStateVertex

The IRPConnector interface represents the characteristics shared by the various types of "connector" elements that can be included in a statechart, such as condition connectors, history connectors, join sync bar connectors, and fork sync bar connectors.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPTransition createDefaultTransition(IRPState from)
          Creates a default transition leading to this connector, within the state specified.
 java.lang.String getConnectorType()
          Returns the type of the connector: Condition, Diagram, EnterExit, Fork, History, Join, Junction, Termination, InPin, OutPin, or InOutPin.
 IRPCollection getDerivedInEdges()
          Returns a collection of the transitions coming into the connector.
 IRPTransition getDerivedOutEdge()
          Returns the transition exiting the connector.
 IRPSwimlane getItsSwimlane()
          For connectors in a swimlane, returns the swimlane that contains the connector.
 IRPState getOfState()
          For history connectors, returns the state that the history connector belongs to.
 int isConditionConnector()
          Checks whether the connector is a condition connector.
 int isDiagramConnector()
          Checks whether the connector is a diagram connector.
 int isForkConnector()
          Checks whether the connector is a fork sync bar connector.
 int isHistoryConnector()
          Checks whether the connector is a history connector.
 int isJoinConnector()
          Checks whether the connector is a join sync bar connector.
 int isJunctionConnector()
          Checks whether the connector is a junction connector.
 int isStubConnector()
          Checks whether the connector is an EnterExit point.
 int isTerminationConnector()
          Checks whether the connector is a termination connector.
 void setItsSwimlane(IRPSwimlane pVal)
          Specifies the swimlane that should contain this connector.
 void setOfState(IRPState OfState)
          For history connectors, specifies the state for which the connector should maintain historical state information.
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPStateVertex
addFlow, addTransition, deleteTransition, getInTransitions, getOutTransitions, getParent, setParent
 
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

createDefaultTransition

IRPTransition createDefaultTransition(IRPState from)
Creates a default transition leading to this connector, within the state specified.

Parameters:
from - the state for which the default transition should be created
Returns:
the default transition that was created

getConnectorType

java.lang.String getConnectorType()
Returns the type of the connector: Condition, Diagram, EnterExit, Fork, History, Join, Junction, Termination, InPin, OutPin, or InOutPin.

Returns:
the type of the connector

getDerivedInEdges

IRPCollection getDerivedInEdges()
Returns a collection of the transitions coming into the connector.

Returns:
the transitions coming into the connector (a collection of IRPTransition elements)

getDerivedOutEdge

IRPTransition getDerivedOutEdge()
Returns the transition exiting the connector.

Returns:
the transition exiting the connector

getItsSwimlane

IRPSwimlane getItsSwimlane()
For connectors in a swimlane, returns the swimlane that contains the connector.

Returns:
the swimlane that contains the connector

getOfState

IRPState getOfState()
For history connectors, returns the state that the history connector belongs to. This is the state for which the history connector maintains historical state information.

Returns:
the state that this history connector belongs to

isConditionConnector

int isConditionConnector()
Checks whether the connector is a condition connector.

Returns:
1 if the connector is a condition connector, 0 otherwise

isDiagramConnector

int isDiagramConnector()
Checks whether the connector is a diagram connector.

Returns:
1 if the connector is a diagram connector, 0 otherwise

isForkConnector

int isForkConnector()
Checks whether the connector is a fork sync bar connector.

Returns:
1 if the connector is a fork sync bar connector, 0 otherwise

isHistoryConnector

int isHistoryConnector()
Checks whether the connector is a history connector.

Returns:
1 if the connector is a history connector, 0 otherwise

isJoinConnector

int isJoinConnector()
Checks whether the connector is a join sync bar connector.

Returns:
1 if the connector is a join sync bar connector, 0 otherwise

isJunctionConnector

int isJunctionConnector()
Checks whether the connector is a junction connector.

Returns:
1 if the connector is a junction connector, 0 otherwise

isStubConnector

int isStubConnector()
Checks whether the connector is an EnterExit point. (Prior to version 6.0 of Rhapsody, EnterExit points were known as stub connectors.)

Returns:
1 if the connector is an EnterExit point, 0 otherwise

isTerminationConnector

int isTerminationConnector()
Checks whether the connector is a termination connector.

Returns:
1 if the connector is a termination connector, 0 otherwise

setItsSwimlane

void setItsSwimlane(IRPSwimlane pVal)
Specifies the swimlane that should contain this connector.

Parameters:
pVal - the swimlane that should contain this connector

setOfState

void setOfState(IRPState OfState)
For history connectors, specifies the state for which the connector should maintain historical state information.

Parameters:
OfState - the state for which the connector should maintain historical state information