com.telelogic.rhapsody.core
Interface IRPPin

All Superinterfaces:
IRPConnector, IRPModelElement, IRPStateVertex

public interface IRPPin
extends IRPConnector

The IRPPin interface represents action pins added to actions, or activity parameters added to action blocks, in an activity diagram. To add an action pin to an action, use IRPState.addConnector, for example: action1.addConnector("InPin"), action1.addConnector("OutPin"), or action1.addConnector("InOutPin").


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 int getIsParameter()
          Checks whether the element is an activity parameter or an action pin.
 java.lang.String getPinDirection()
          Returns the direction of the pin/parameter: In, Out, or InOut.
 IRPClassifier getPinType()
          Returns the type of the value held by the pin/parameter.
 void setIsParameter(int isParameter)
          Specifies whether the element should be an activity parameter or an action pin.
 void setPinDirection(java.lang.String pinDirection)
          Specifies the direction of the pin/parameter.
 void setPinType(IRPClassifier pinType)
          Specifies the type to use for the value held by the pin/parameter.
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPConnector
createDefaultTransition, getConnectorType, getDerivedInEdges, getDerivedOutEdge, getItsSwimlane, getOfState, isConditionConnector, isDiagramConnector, isForkConnector, isHistoryConnector, isJoinConnector, isJunctionConnector, isStubConnector, isTerminationConnector, setItsSwimlane, setOfState
 
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

getIsParameter

int getIsParameter()
Checks whether the element is an activity parameter or an action pin.

Returns:
1 if the element is an activity parameter, 0 if the element is an action pin.

getPinDirection

java.lang.String getPinDirection()
Returns the direction of the pin/parameter: In, Out, or InOut.

Returns:
the direction of the pin/parameter

getPinType

IRPClassifier getPinType()
Returns the type of the value held by the pin/parameter.

Returns:
the type of the value held by the pin/parameter

setIsParameter

void setIsParameter(int isParameter)
Specifies whether the element should be an activity parameter or an action pin.

Parameters:
isParameter - use 1 if you want the element to be an activity parameter, use 0 if you want the element to be an action pin

setPinDirection

void setPinDirection(java.lang.String pinDirection)
Specifies the direction of the pin/parameter.

Parameters:
pinDirection - the direction that should be used for the pin/parameter. The valid strings for this parameter are: In, Out, and InOut

setPinType

void setPinType(IRPClassifier pinType)
Specifies the type to use for the value held by the pin/parameter.

Parameters:
pinType - the type to use for the value held by the pin/parameter