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

All Superinterfaces:
Excludable, InheritableExcludableValue<CallEvent,RTProtocol>

public interface RTInheritableEvent
extends InheritableExcludableValue<CallEvent,RTProtocol>

Represents UMLRT Inheritable Event

Author:
gsturov

Nested Class Summary
static class RTInheritableEvent.DATACLASS_KIND
           
 
Method Summary
 Type getDataClass()
          If the getDataClassKind call returns CONCRETE_DATACLASS this method will returns type representing the dataclass of the protocol event.
 RTInheritableEvent.DATACLASS_KIND getDataClassKind()
          Returns the kind of the given event dataclass
 java.lang.String getName(boolean getQualified)
          Gets the name of this protocol event for display in the UI.
 boolean isInEvent()
           
 boolean isOutEvent()
           
 void setDataClass(RTInheritableEvent.DATACLASS_KIND kind, Type dataclass)
          Sets dataclass for given protocol event
 void setName(java.lang.String name)
          Sets the name of this protocol event.
 
Methods inherited from interface com.ibm.xtools.uml.rt.core.Excludable
canExclude, exclude, isExcluded, unexclude
 

Method Detail

getDataClassKind

RTInheritableEvent.DATACLASS_KIND getDataClassKind()
Returns the kind of the given event dataclass


getDataClass

Type getDataClass()
If the getDataClassKind call returns CONCRETE_DATACLASS this method will returns type representing the dataclass of the protocol event. Returns null if the dataclass is not set to concrete type.

Returns:
the type of the protocol's data class

setDataClass

void setDataClass(RTInheritableEvent.DATACLASS_KIND kind,
                  Type dataclass)
                  throws ExecutionException
Sets dataclass for given protocol event

Parameters:
kind - of the dataclass to set
dataclass - type representing the dataclass if kind is CONCRETE_DATACLASS. Ignored otherwise.
Throws:
ExecutionException

getName

java.lang.String getName(boolean getQualified)
Gets the name of this protocol event for display in the UI.

Parameters:
getQualified - whether or not to return the qualified name of the event
Returns:

setName

void setName(java.lang.String name)
Sets the name of this protocol event.


isInEvent

boolean isInEvent()
Returns:
true if this is an "in" event

isOutEvent

boolean isOutEvent()
Returns:
true if this is an "out" event