[This is preliminary documentation and is subject to change.]
A specialization of SifElement for SIF infrastructure messages such as
SIF_Register, SIF_Request, and SIF_Event.
SifMessagePayload provides methods specific to infrastructure messages, such
as retrieving the Edustructures.SifWorks or its individual fields. When an instance of
this class is constructed, it is done so without its Edustructures.SifWorks element. The
getHeader method adds a Edustructures.SifWorks child if one does not exist,
and the class framework takes care of assigning values to the header prior to
sending messages.
For consistency the Adk employs the same SifElement class hierarchy and
conventions for SIF Infrastructure messages as it does for SIF Data Objects.
Some inherited methods of SifElement, such as setChanged and setEmpty, have
no effect for infrastructure messages.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public abstract class SifMessagePayload : SifElement
Public MustInherit Class SifMessagePayload _ Inherits SifElement
public ref class SifMessagePayload abstract : public SifElement
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | SifMessagePayloadSifMessagePayloadNew(IElementDef) | Constructor |
| SifMessagePayloadSifMessagePayloadNew(SifVersion, IElementDef) | Constructor |
| AckError(SifErrorCategoryCode, Int32, String) | Create an error SIF_Ack for this message. |
| AckError(SifErrorCategoryCode, Int32, String, String) | Create an error SIF_Ack for this message. |
| ackFinal()() | Create a Final SIF_Ack for this message. |
| AckImmediate()() | Create an Immediate SIF_Ack for this message. |
| ackIntermediate()() | Create an Intermediate SIF_Ack for this message. |
| ackStatus(Int32) | Create a SIF_Ack for this message. |
 | DestinationId | Gets the SIF_DestinationId value from this message's header.
If the message does not have a Edustructures.SifWorks element, one is created.
|
| getXmlns()() | Returns the XML namespace of this message |
| Header | Returns the Edustructures.SifWorks element. A new Edustructures.SifWorks is created for this
object if one does not already exist.
|
| LogRecv(ILog) | Utility method called by the class framework to log this SIF_Message
upon receipt from a zone.
|
| LogSend(ILog) | Utility method called by the class framework to log this SIF_Message
prior to sending it to a zone.
|
| MsgId | Gets the SIF_MsgId value from this message's header.
If the message does not have a Edustructures.SifWorks element, one is created.
|
| SIFContexts |
Gets the list of SIFContexts associated with this message.
|
| SifVersion | Gets the SIF Version to which this message conforms. (Overrides SifElement.SifVersion.) |
| SourceId | Gets the SIF_SourceId value from this message's header.
If the message does not have a Edustructures.SifWorks element, one is created.
|
| Timestamp | Gets the timestamp of this message from the SIF_Date and SIF_Time
elements in its header.
If the message does not have a Edustructures.SifWorks element, one is created with
a timestamp equal to the current time.
|
| VersionAttribute | Returns the Version attribute of this SIF_Message.
The Version attribute was introduced in SIF 1.1, which uses the attribute
to identify the version of SIF to which a message conforms. Prior
versions of SIF encode the version in the namespace.
|
Inheritance Hierarchy
