com.telelogic.rhapsody.core
Interface IRPCollaboration

All Superinterfaces:
IRPModelElement
All Known Subinterfaces:
IRPInteractionOperand

public interface IRPCollaboration
extends IRPModelElement

The IRPCollaboration interface represents the capabilities included in sequence diagrams and communications diagrams. To get the IRPCollaboration object underlying a sequence diagram or a communication diagram, use the methods IRPSequenceDiagram.getLogicalCollaboration() and IRPCollaborationDiagram.getLogicalCollaboration().


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 IRPActionBlock addActionBlock(IRPClassifierRole classifier)
          Adds a new action block to the specified classifier.
 IRPMessage addCancelledTimeout(IRPClassifierRole receiver)
          Adds a cancelled timeout to the specified instance line.
 IRPClassifierRole addClassifierRole(java.lang.String newVal, IRPClassifier cls)
          Adds an instance line to a sequence diagram.
 IRPClassifierRole addClassifierRoleByName(java.lang.String newVal, java.lang.String classFullPath)
          method addClassifierRoleByName
 IRPClassifierRole addClassifierRoleForInstance(IRPInstance inst)
          method addClassifierRoleForInstance
 IRPMessage addConditionMark(IRPClassifierRole classifier)
          Adds a condition mark to the specified instance line.
 IRPMessage addCtor(IRPInterfaceItem interItem, java.lang.String actualParamList, IRPClassifierRole sender, IRPClassifierRole receiver)
          Adds a Create Arrow to a sequence diagram.
 IRPMessage addDataFlow(IRPSysMLPort flowPort, java.lang.String value, IRPClassifierRole sender, IRPClassifierRole receiver)
          method addDataFlow
 IRPMessage addDestructionEvent(IRPClassifierRole classifier)
          Adds a destruction event to the specified lifeline.
 IRPMessage addDtor(IRPInterfaceItem interItem, java.lang.String actualParamList, IRPClassifierRole sender, IRPClassifierRole receiver)
          Adds a Destroy Arrow to a sequence diagram.
 IRPMessage addDurationConstraint(java.lang.String durationConstraint, IRPMessage startState, IRPMessage endState)
          Adds a Duration Constraint to the specified state invariants.
 IRPMessage addDurationObservation(java.lang.String durationObservation, IRPMessage startState, IRPMessage endState)
          Adds a Duration Observation to the specified states invariants.
 IRPMessage addFoundMessage(IRPClassifierRole receiver)
          Adds a Found Message to the specified lifeline.
 IRPInteractionOccurrence addInteractionOccurrence()
          Adds an interaction occurrence.
 IRPInteractionOperator addInteractionOperator()
          Adds an interaction operator to a sequence diagram.
 IRPMessage addLostMessage(IRPClassifierRole sender)
          Adds a Lost Message to the specified lifeline.
 IRPMessage addMessage(IRPInterfaceItem interItem, java.lang.String actualParamList, IRPClassifierRole sender, IRPClassifierRole receiver)
          Adds a message to a sequence diagram.
 IRPMessage addReplyMessage(IRPInterfaceItem interItem, java.lang.String actualParamList, IRPClassifierRole sender, IRPClassifierRole receiver)
          method addReplyMessage
 IRPMessage addStateInvariant(java.lang.String invariant, IRPClassifierRole classifier)
          Adds a State Invariant to the specified lifeline.
 IRPClassifierRole addSystemBorder()
          Adds a System Border element to a sequence diagram.
 IRPMessage addTimeConstraint(java.lang.String timeConstraint, IRPMessage state)
          Adds a Time Constraint to the specified state invariant.
 IRPMessage addTimeInterval(IRPClassifierRole receiver)
          Adds a Time Interval to the specified lifeline.
 IRPMessage addTimeObservation(java.lang.String timeObservation, IRPMessage state)
          Adds a Time Observation to the specified state invariant.
 IRPMessage addTimeout(IRPInterfaceItem interItem, java.lang.String actualParamList, IRPClassifierRole sender, IRPClassifierRole receiver)
          Adds a timeout to a sequence diagram.
 IRPSequenceDiagram generateSequence(java.lang.String newVal, IRPPackage owner)
          Generates a sequence diagram from the content of the IRPCollaboration object.
 java.lang.String getActivationCondition()
          get property activationCondition
 java.lang.String getActivationMode()
          get property activationMode
 IRPMessage getActivator(IRPMessage msg)
          method getActivator
 IRPCollection getAssociations()
          get property associations
 IRPCollection getClassifier()
          Returns a collection of all the instance lines in the sequence diagram.
 IRPCollection getConcurrentGroup(IRPMessage msg)
          method getConcurrentGroup
 IRPCollection getExecutionOccurrences()
          Returns a collection of all the Execution Occurrences in the diagram.
 IRPCollection getInteractionOccurrences()
          Returns a collection of all the interaction occurrences in the sequence diagram.
 IRPCollection getInteractionOperators()
          Returns a collection of all the interaction operators in the sequence diagram.
 IRPCollection getMessagePoints()
          Returns all the message points along the specified instance line.
 IRPCollection getMessagePoints(IRPClassifierRole classifier)
          Returns all the message points along the specified instance line.
 IRPCollection getMessages()
          Returns a collection of all the messages in the sequence diagram.
 java.lang.String getMode()
          get property mode
 IRPMessage getPredecessor(IRPMessage msg)
          Returns the message that precedes the specified message.
 IRPMessage getSuccessor(IRPMessage msg)
          Returns the message that follows the specified message.
 
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

addActionBlock

IRPActionBlock addActionBlock(IRPClassifierRole classifier)
Adds a new action block to the specified classifier.

Parameters:
classifier - the classifier to which the action block should be added
Returns:
the action block that was created

addCancelledTimeout

IRPMessage addCancelledTimeout(IRPClassifierRole receiver)
Adds a cancelled timeout to the specified instance line.

Parameters:
receiver - the instance line that the cancelled timeout should be added to
Returns:
the cancelled timeout that was added

addClassifierRole

IRPClassifierRole addClassifierRole(java.lang.String newVal,
                                    IRPClassifier cls)
Adds an instance line to a sequence diagram.

Parameters:
newVal - the name to use for the new instance line
cls - the class that the instance line is based on
Returns:
the instance line that was added

addClassifierRoleByName

IRPClassifierRole addClassifierRoleByName(java.lang.String newVal,
                                          java.lang.String classFullPath)
method addClassifierRoleByName

Throws:
RhapsodyRuntimeException

addClassifierRoleForInstance

IRPClassifierRole addClassifierRoleForInstance(IRPInstance inst)
method addClassifierRoleForInstance

Throws:
RhapsodyRuntimeException

addConditionMark

IRPMessage addConditionMark(IRPClassifierRole classifier)
Adds a condition mark to the specified instance line.

Parameters:
classifier - the instance line to which the condition mark should be added
Returns:
the condition mark that was created

addCtor

IRPMessage addCtor(IRPInterfaceItem interItem,
                   java.lang.String actualParamList,
                   IRPClassifierRole sender,
                   IRPClassifierRole receiver)
Adds a Create Arrow to a sequence diagram.

Parameters:
interItem - the constructor for the object to be created
actualParamList - string representing the arguments to pass to the constructor. The string provided should be a comma-separated list of arguments
sender - the instance line at which the Create Arrow begins
receiver - the instance line at which the Create Arrow ends (representing the object to be created)
Returns:
the Create Arrow that was added to the diagram

addDataFlow

IRPMessage addDataFlow(IRPSysMLPort flowPort,
                       java.lang.String value,
                       IRPClassifierRole sender,
                       IRPClassifierRole receiver)
method addDataFlow

Throws:
RhapsodyRuntimeException

addDestructionEvent

IRPMessage addDestructionEvent(IRPClassifierRole classifier)
Adds a destruction event to the specified lifeline.

Parameters:
classifier - the lifeline that the destruction event should be added to
Returns:
the destruction event that was created

addDtor

IRPMessage addDtor(IRPInterfaceItem interItem,
                   java.lang.String actualParamList,
                   IRPClassifierRole sender,
                   IRPClassifierRole receiver)
Adds a Destroy Arrow to a sequence diagram.

Parameters:
interItem - the destructor for the object to be destroyed
actualParamList - since destructors do not take arguments, use an empty string "" for this parameter
sender - the instance line at which the Destroy Arrow begins
receiver - the instance line at which the Destroy Arrow ends (representing the object to be destroyed)
Returns:
the Destroy Arrow that was added to the diagram

addDurationConstraint

IRPMessage addDurationConstraint(java.lang.String durationConstraint,
                                 IRPMessage startState,
                                 IRPMessage endState)
Adds a Duration Constraint to the specified state invariants.

Parameters:
durationConstraint - the text to display above the new Duration Constraint
startState - the state invariant at which the new Duration Constraint should begin
endState - the state invariant at which the new Duration Constraint should end. If you want the Duration Constraint to cover only a single state invariant, specify the same state invariant for both the startState parameter and the endState parameter
Returns:
the Duration Constraint that was created

addDurationObservation

IRPMessage addDurationObservation(java.lang.String durationObservation,
                                  IRPMessage startState,
                                  IRPMessage endState)
Adds a Duration Observation to the specified states invariants.

Parameters:
durationObservation - the text to display above the new Duration Observation
startState - the state invariant at which the new Duration Observation should begin
endState - the state invariant at which the new Duration Observation should end. If you want the Duration Observation to cover only a single state invariant, specify the same state invariant for both the startState parameter and the endState parameter
Returns:
the Duration Observation that was created

addFoundMessage

IRPMessage addFoundMessage(IRPClassifierRole receiver)
Adds a Found Message to the specified lifeline.

Parameters:
receiver - the lifeline that the Found Message should be added to
Returns:
the Found Message that was created

addInteractionOccurrence

IRPInteractionOccurrence addInteractionOccurrence()
Adds an interaction occurrence.

Returns:
the interaction occurrence that was created

addInteractionOperator

IRPInteractionOperator addInteractionOperator()
Adds an interaction operator to a sequence diagram.

Returns:
the interaction operator that was added

addLostMessage

IRPMessage addLostMessage(IRPClassifierRole sender)
Adds a Lost Message to the specified lifeline.

Parameters:
sender - the lifeline that the Lost Message should be added to
Returns:
the Lost Message that was created

addMessage

IRPMessage addMessage(IRPInterfaceItem interItem,
                      java.lang.String actualParamList,
                      IRPClassifierRole sender,
                      IRPClassifierRole receiver)
Adds a message to a sequence diagram.

Parameters:
interItem - the operation call represented by the message
actualParamList - the arguments to pass to the operation. If the operation does not take any arguments, use an empty string "" for this parameter
sender - the instance line sending the message
receiver - the instance line receiving the message
Returns:
the message that was added to the diagram

addReplyMessage

IRPMessage addReplyMessage(IRPInterfaceItem interItem,
                           java.lang.String actualParamList,
                           IRPClassifierRole sender,
                           IRPClassifierRole receiver)
method addReplyMessage

Throws:
RhapsodyRuntimeException

addStateInvariant

IRPMessage addStateInvariant(java.lang.String invariant,
                             IRPClassifierRole classifier)
Adds a State Invariant to the specified lifeline.

Parameters:
invariant - the text to use for the Invariant field of the new State Invariant
classifier - the lifeline that the State Invariant should be added to
Returns:
the State Invariant that was created

addSystemBorder

IRPClassifierRole addSystemBorder()
Adds a System Border element to a sequence diagram.

Returns:
the System Border element that was added

addTimeConstraint

IRPMessage addTimeConstraint(java.lang.String timeConstraint,
                             IRPMessage state)
Adds a Time Constraint to the specified state invariant.

Parameters:
timeConstraint - the text to display for the new Time Constraint
state - the state invariant to which the new Time Constraint should be added
Returns:
the Time Constraint that was created

addTimeInterval

IRPMessage addTimeInterval(IRPClassifierRole receiver)
Adds a Time Interval to the specified lifeline.

Parameters:
receiver - the lifeline that the Time Interval should be added to
Returns:
the Time Interval that was created

addTimeObservation

IRPMessage addTimeObservation(java.lang.String timeObservation,
                              IRPMessage state)
Adds a Time Observation to the specified state invariant.

Parameters:
timeObservation - the text to display for the new Time Observation
state - the state invariant to which the new Time Observation should be added
Returns:
the Time Observation that was created

addTimeout

IRPMessage addTimeout(IRPInterfaceItem interItem,
                      java.lang.String actualParamList,
                      IRPClassifierRole sender,
                      IRPClassifierRole receiver)
Adds a timeout to a sequence diagram.

Parameters:
interItem - use null for this parameter
actualParamList - duration of timeout in milliseconds
sender - the instance line that the timeout should be added to
receiver - use null for this parameter
Returns:
the timeout created

generateSequence

IRPSequenceDiagram generateSequence(java.lang.String newVal,
                                    IRPPackage owner)
Generates a sequence diagram from the content of the IRPCollaboration object.

Parameters:
newVal - the name to give to the new diagram
owner - the package to which the new diagram should belong
Returns:
the sequence diagram created

getActivationCondition

java.lang.String getActivationCondition()
get property activationCondition

Throws:
RhapsodyRuntimeException

getActivationMode

java.lang.String getActivationMode()
get property activationMode

Throws:
RhapsodyRuntimeException

getActivator

IRPMessage getActivator(IRPMessage msg)
method getActivator

Throws:
RhapsodyRuntimeException

getAssociations

IRPCollection getAssociations()
get property associations

Throws:
RhapsodyRuntimeException

getClassifier

IRPCollection getClassifier()
Returns a collection of all the instance lines in the sequence diagram.

Returns:
all the instance lines in the sequence diagram

getConcurrentGroup

IRPCollection getConcurrentGroup(IRPMessage msg)
method getConcurrentGroup

Throws:
RhapsodyRuntimeException

getExecutionOccurrences

IRPCollection getExecutionOccurrences()
Returns a collection of all the Execution Occurrences in the diagram.

Returns:
all the Execution Occurrences in the diagram

getInteractionOccurrences

IRPCollection getInteractionOccurrences()
Returns a collection of all the interaction occurrences in the sequence diagram.

Returns:
all the interaction occurrences in the sequence diagram

getInteractionOperators

IRPCollection getInteractionOperators()
Returns a collection of all the interaction operators in the sequence diagram.

Returns:
all the interaction operators in the sequence diagram

getMessagePoints

IRPCollection getMessagePoints(IRPClassifierRole classifier)
Returns all the message points along the specified instance line.

Returns:
a collection of IRPMessagePoint objects, representing all the message points along the specified instance line (in the correct order)

getMessagePoints

IRPCollection getMessagePoints()
Returns all the message points along the specified instance line.

Returns:
a collection of IRPMessagePoint objects, representing all the message points along the specified instance line (in the correct order)

getMessages

IRPCollection getMessages()
Returns a collection of all the messages in the sequence diagram.

Returns:
all the messages in the sequence diagram

getMode

java.lang.String getMode()
get property mode

Throws:
RhapsodyRuntimeException

getPredecessor

IRPMessage getPredecessor(IRPMessage msg)
Returns the message that precedes the specified message.

Parameters:
msg - the message whose predecessor has to be found
Returns:
the message that precedes the specified message

getSuccessor

IRPMessage getSuccessor(IRPMessage msg)
Returns the message that follows the specified message.

Parameters:
msg - the message whose successor has to be found
Returns:
the message that follows the specified message