com.edustructures.sifworks.food
Class EarnedStatus

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.food.EarnedStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class EarnedStatus
extends SIFKeyedElement

This gives information about a staff member's meal status.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

EarnedStatus()
Constructor

EarnedStatus(YesNoNA type)
Constructor that accepts values for all mandatory fields

Method Summary

java.util.Calendar	getEndDate() Gets the value of the <EndDate> element.
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.util.Calendar	getStartDate() Gets the value of the <StartDate> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	setEndDate(java.util.Calendar value) Sets the value of the <EndDate> element.
void	setStartDate(java.util.Calendar value) Sets the value of the <StartDate> element.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.
void	setType(YesNoNA value) Sets the value of the Type attribute.

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

EarnedStatus

public EarnedStatus()

Constructor

EarnedStatus

public EarnedStatus(YesNoNA type)

Constructor that accepts values for all mandatory fields

Parameters:

type - Earned status type.

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

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Earned status type."

Returns:

The Type attribute of this object.

Since:

1.5r1

setType

public void setType(YesNoNA value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Earned status type."

Parameters:

value - A constant defined by the YesNoNA class

Since:

1.5r1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: "Earned status type."

Parameters:

value - The value as a String

Since:

1.5r1

getStartDate

public java.util.Calendar getStartDate()

Gets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "Date on which earned status became effective (inclusive)."

Returns:

The StartDate element of this object.

Since:

1.5r1

setStartDate

public void setStartDate(java.util.Calendar value)

Sets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "Date on which earned status became effective (inclusive)."

Parameters:

value - A Calendar object

Since:

1.5r1

getEndDate

public java.util.Calendar getEndDate()

Gets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "Date on which earned status was last in effect. This attribute is conditional upon the StartDate element. It exists only if the StartDate element exists."

Returns:

The EndDate element of this object.

Since:

1.5r1

setEndDate

public void setEndDate(java.util.Calendar value)

Sets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "Date on which earned status was last in effect. This attribute is conditional upon the StartDate element. It exists only if the StartDate element exists."

Parameters:

value - A Calendar object

Since:

1.5r1