com.edustructures.sifworks.library
Class Message

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.library.Message

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Message
extends SIFKeyedElement

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

Message()
Constructor

Message(Priority priority, java.lang.String text)
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
java.lang.String	getPriority() Gets the value of the Priority attribute.
java.util.Calendar	getSent() Gets the value of the <Sent> element.
java.lang.String	getText() Gets the value of the <Text> element.
void	setPriority(Priority value) Sets the value of the Priority attribute.
void	setPriority(java.lang.String value) Sets the value of the Priority attribute as a String.
void	setSent(java.util.Calendar value) Sets the value of the <Sent> element.
void	setText(java.lang.String value) Sets the value of the <Text> 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

Message

public Message()

Constructor

Message

public Message(Priority priority,
               java.lang.String text)

Constructor that accepts values for all mandatory fields

Parameters:

priority - The level of urgency associated with this message.

text - The contents of the message.

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

getPriority

public java.lang.String getPriority()

Gets the value of the Priority attribute.

The SIF specification defines the meaning of this attribute as: "The level of urgency associated with this message."

Returns:

The Priority attribute of this object.

Since:

1.1

setPriority

public void setPriority(Priority value)

Sets the value of the Priority attribute.

The SIF specification defines the meaning of this attribute as: "The level of urgency associated with this message."

Parameters:

value - A constant defined by the Priority class

Since:

1.1

setPriority

public void setPriority(java.lang.String value)

Sets the value of the Priority attribute as a String.

The SIF specification defines the meaning of this attribute as: "The level of urgency associated with this message."

Parameters:

value - The value as a String

Since:

1.1

getSent

public java.util.Calendar getSent()

Gets the value of the <Sent> element.

The SIF specification defines the meaning of this element as: "The date and time that this message was originally 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	"Date"
SIF2.0	"Sent"

Returns:

The Sent element of this object.

Since:

1.1

setSent

public void setSent(java.util.Calendar value)

Sets the value of the <Sent> element.

The SIF specification defines the meaning of this element as: "The date and time that this message was originally 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	"Date"
SIF2.0	"Sent"

Parameters:

value - A Calendar object

Since:

1.1

getText

public java.lang.String getText()

Gets the value of the <Text> element.

The SIF specification defines the meaning of this element as: "The contents of the message."

Returns:

The Text element of this object.

Since:

1.1

setText

public void setText(java.lang.String value)

Sets the value of the <Text> element.

The SIF specification defines the meaning of this element as: "The contents of the message."

Parameters:

value - A String object

Since:

1.1