com.edustructures.sifworks.infra
Class SIF_Header

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.infra.SIF_Header

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Header
extends SIFKeyedElement

Common message header for all SIF messages

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_Header()
Constructor

SIF_Header(java.lang.String sifMsgId, java.util.Calendar sifTimestamp, java.lang.String sifSourceId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
SIF_Contexts	getSIF_Contexts() Gets the value of the <SIF_Contexts> element.
java.lang.String	getSIF_DestinationId() Gets the value of the <SIF_DestinationId> element.
java.lang.String	getSIF_MsgId() Gets the value of the <SIF_MsgId> element.
SIF_Security	getSIF_Security() Gets the value of the <SIF_Security> element.
java.lang.String	getSIF_SourceId() Gets the value of the <SIF_SourceId> element.
java.util.Calendar	getSIF_Timestamp() Gets the value of the <SIF_Timestamp> element.
void	removeSIF_Contexts() Removes the SIF_Contexts child element previously created by calling setSIF_Contexts
void	removeSIF_Security() Removes the SIF_Security child element previously created by calling setSIF_Security
void	setSIF_Contexts(SIF_Contexts value) Sets the value of the <SIF_Contexts> element.
void	setSIF_DestinationId(java.lang.String value) Sets the value of the <SIF_DestinationId> element.
void	setSIF_MsgId(java.lang.String value) Sets the value of the <SIF_MsgId> element.
void	setSIF_Security(SIF_SecureChannel sifSecureChannel) Sets the value of the <SIF_Security> child element.
void	setSIF_Security(SIF_Security value) Sets the value of the <SIF_Security> element.
void	setSIF_SourceId(java.lang.String value) Sets the value of the <SIF_SourceId> element.
void	setSIF_Timestamp(java.util.Calendar value) Sets the value of the <SIF_Timestamp> element.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SIF_Header

public SIF_Header()

Constructor

SIF_Header

public SIF_Header(java.lang.String sifMsgId,
                  java.util.Calendar sifTimestamp,
                  java.lang.String sifSourceId)

Constructor that accepts values for all mandatory fields

Parameters:

sifMsgId - SIF_MsgId is a globally unique message identifier from the Agent or ZIS that sends out the message.

sifTimestamp - Timestamp of when the message was sent.

sifSourceId - The SIF_SourceId is the ID of the originator of the message. Each source needs to have a zone unique case-sensitive identifier.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getSIF_MsgId

public java.lang.String getSIF_MsgId()

Gets the value of the <SIF_MsgId> element.

The SIF specification defines the meaning of this element as: "SIF_MsgId is a globally unique message identifier from the Agent or ZIS that sends out the message."

Returns:

The SIF_MsgId element of this object.

Since:

1.1

setSIF_MsgId

public void setSIF_MsgId(java.lang.String value)

Sets the value of the <SIF_MsgId> element.

The SIF specification defines the meaning of this element as: "SIF_MsgId is a globally unique message identifier from the Agent or ZIS that sends out the message."

Parameters:

value - A String object

Since:

1.1

getSIF_Timestamp

public java.util.Calendar getSIF_Timestamp()

Gets the value of the <SIF_Timestamp> element.

The SIF specification defines the meaning of this element as: "Timestamp of when the message was sent."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"SIF_Date"
SIF2.0	"SIF_Timestamp"

Returns:

The SIF_Timestamp element of this object.

Since:

1.1

setSIF_Timestamp

public void setSIF_Timestamp(java.util.Calendar value)

Sets the value of the <SIF_Timestamp> element.

The SIF specification defines the meaning of this element as: "Timestamp of when the message was sent."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"SIF_Date"
SIF2.0	"SIF_Timestamp"

Parameters:

value - A Calendar object

Since:

1.1

setSIF_Security

public void setSIF_Security(SIF_Security value)

Sets the value of the <SIF_Security> element.

Parameters:

value - A SIF_Security object

Since:

1.1

setSIF_Security

public void setSIF_Security(SIF_SecureChannel sifSecureChannel)

Sets the value of the <SIF_Security> child element. This form of setSIF_Security is provided as a convenience method that is functionally equivalent to the version of setSIF_Security that accepts a single SIF_Security object.

Parameters:

sifSecureChannel -

Since:

1.1

getSIF_Security

public SIF_Security getSIF_Security()

Gets the value of the <SIF_Security> element.

Returns:

A SIF_Security object

Since:

1.1

removeSIF_Security

public void removeSIF_Security()

Removes the SIF_Security child element previously created by calling setSIF_Security

Since:

1.1

getSIF_SourceId

public java.lang.String getSIF_SourceId()

Gets the value of the <SIF_SourceId> element.

The SIF specification defines the meaning of this element as: "The SIF_SourceId is the ID of the originator of the message. Each source needs to have a zone unique case-sensitive identifier."

Returns:

The SIF_SourceId element of this object.

Since:

1.1

setSIF_SourceId

public void setSIF_SourceId(java.lang.String value)

Sets the value of the <SIF_SourceId> element.

The SIF specification defines the meaning of this element as: "The SIF_SourceId is the ID of the originator of the message. Each source needs to have a zone unique case-sensitive identifier."

Parameters:

value - A String object

Since:

1.1

getSIF_DestinationId

public java.lang.String getSIF_DestinationId()

Gets the value of the <SIF_DestinationId> element.

The SIF specification defines the meaning of this element as: "This element represents the ID of the recipient of the message and may be present as follows:"

Returns:

The SIF_DestinationId element of this object.

Since:

1.1

setSIF_DestinationId

public void setSIF_DestinationId(java.lang.String value)

Sets the value of the <SIF_DestinationId> element.

The SIF specification defines the meaning of this element as: "This element represents the ID of the recipient of the message and may be present as follows:"

Parameters:

value - A String object

Since:

1.1

setSIF_Contexts

public void setSIF_Contexts(SIF_Contexts value)

Sets the value of the <SIF_Contexts> element.

The SIF specification defines the meaning of this element as: " Each SIF Context that applies to the message. If none is specified, the applicable context is Default. Repeatable for SIF_Events, not repeatable for SIF_Request or SIF_Response. "

Parameters:

value - A SIF_Contexts object

Since:

2.0

getSIF_Contexts

public SIF_Contexts getSIF_Contexts()

Gets the value of the <SIF_Contexts> element.

The SIF specification defines the meaning of this element as: " Each SIF Context that applies to the message. If none is specified, the applicable context is Default. Repeatable for SIF_Events, not repeatable for SIF_Request or SIF_Response. "

Returns:

A SIF_Contexts object

Since:

2.0

removeSIF_Contexts

public void removeSIF_Contexts()

Removes the SIF_Contexts child element previously created by calling setSIF_Contexts

Since:

2.0