com.ibm.xtools.uml.rt.core
Interface RTProtocol


public interface RTProtocol

Represents UMLRT Protocol

Author:
gsturov

Method Summary
 java.util.Collection<RTInheritableEvent> getAllInEvents()
          Returns a list of all local+inherited in events for the protocol (includes excluded events).
 java.util.Collection<RTInheritableEvent> getAllOutEvents()
          Returns a list of all local+inherited out events for the protocol (includes excluded events).
 Collaboration getCollaboration()
           
 java.util.Collection<RTInheritableEvent> getOwnedEvents()
          Returns all events (in and out) owned by this protocol.
 java.util.Collection<RTInheritableEvent> getOwnedInEvents()
          Returns a list of all the in events owned by the protocol's, container (i.e., local only).
 java.util.Collection<RTInheritableEvent> getOwnedOutEvents()
          Returns a list of all the out events owned by the protocol's, container.
 Interface getProtocolRole(boolean getConjugate)
          This method will find the interface owned by the protocol that has the given role (base or conjugate).
 

Method Detail

getCollaboration

Collaboration getCollaboration()
Returns:
Collaboration UML2 element representing this protocol

getProtocolRole

Interface getProtocolRole(boolean getConjugate)
This method will find the interface owned by the protocol that has the given role (base or conjugate). The current method of validation is to find an collaboration owned by the the protocol that has 2 roles 'base' and 'conjugate' that are Ports with type Interface.


getOwnedEvents

java.util.Collection<RTInheritableEvent> getOwnedEvents()
Returns all events (in and out) owned by this protocol.


getOwnedInEvents

java.util.Collection<RTInheritableEvent> getOwnedInEvents()
Returns a list of all the in events owned by the protocol's, container (i.e., local only). Returns an empty list if there are no in events or if the protocol doesn't have a protocol container. The events are returned in the same order as they are found in their containing EList.


getOwnedOutEvents

java.util.Collection<RTInheritableEvent> getOwnedOutEvents()
Returns a list of all the out events owned by the protocol's, container. Returns an empty list if there are no out events or if the protocol doesn't have a protocol container. The events are returned in the same order as they are found in their containing EList.


getAllInEvents

java.util.Collection<RTInheritableEvent> getAllInEvents()
Returns a list of all local+inherited in events for the protocol (includes excluded events).


getAllOutEvents

java.util.Collection<RTInheritableEvent> getAllOutEvents()
Returns a list of all local+inherited out events for the protocol (includes excluded events).