IMessage interface
Namespace: NextDesign.Core
Description
An access object to message information.
Affiliation area
| Name | Description |
|---|---|
| Interaction model | A group of APIs to access the interaction model. |
Inherit Base
| Name | Description |
|---|---|
| IInteractionElement | Access object to interaction model element information. Defines common characteristics for elements that represent interactions. |
Property
| Name | Description |
|---|---|
| Activator | Activation message for this message Returns null if no activation message exists. ■ A startup message is a message that activates the execution specification from which the message is sent. If the source port of this message is an execution spec, then this is the first message received by that execution spec. The interaction is enabled to send this message by receiving the activation message. |
| After | After this message Returns null if there is no after message. ■ Succeeding message The message that is sent immediately after this message and whose sender is the same. However, the trailing message does not include the response message. In addition, if this message type is a response message, the subsequent message will be null. Caution) Please note that even if the message is sent from the same lifeline, the sent message with different execution specifications will not be treated as a succeeding message. |
| Before | The predecessor message for this message Returns null if there is no predecessor message. ■ What is the preceding message? This is the message that is sent immediately before this message and the message whose sender is the same. Preceding messages do not include reply messages. In addition, if this message type is a reply message, the preceding message will be null. Caution) Please note that even if messages are sent from the same lifeline, sent messages with different execution specifications will not be treated as preceding messages. |
| IsAppearance | Is this message an appearance message? Evaluates as an appearance message if the source port of this message is the message end. |
| IsAsynchronous | Is this message an asynchronous message |
| IsLost | Is this message a lost message? Evaluates as an present message if the destination port for this message is the message end. |
| IsReply | Is this message a reply message |
| IsSynchronous | Is this message synchronous? |
| Kind | Type of message - Synchronous: "sync" - Asynchronous: "async" - Generated: "create" - Destroy: "destroy" - Reply: "reply" |
| ReceivePort | Message Destination Port The following model elements correspond to the actual type of the message destination port: |
| ReceivePortType | The type of the destination port for the message Returns one of the following. - Execution specification: "ExecutionSpecification" - Message end: "MessageEnd" - Frame: "Frame" |
| Receiver | Message Receiver Lifeline Returns the lifeline that owns this message's receiver port if it is an execution spec. If the recipient of the message is an element whose lifeline cannot be identified, such as the end of the message, return null. |
| Reply | Reply message corresponding to this message Returns null if there is no corresponding reply message. ■ What is the corresponding response message? This corresponds to the response message returned by the execution specification of the receiver of this message. |
| Sender | Message's source lifeline Returns the lifeline that owns this message's source port if it is an execution spec. If the source of the message is an element whose lifeline cannot be identified, such as at the end of the message, return null. |
| SendPort | Message Source Port The following model elements correspond to the actual type of the message source port: |
| SendPortType | The type of the message's source port Returns one of the following. - Execution specification: "ExecutionSpecification" - Message end: "MessageEnd" - Frame: "Frame" |
| TypeModel | Model mapped to message type |