com.edustructures.sifworks.food
Class StaffMeal

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.food.StaffMeal

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StaffMeal
extends SIFDataObject

This object communicates the current meal status and account status of a given staff member. This object indicates whether the staff member is entitled to earn meals. This object will respond to a change event and propagate the new information to subscribing agents. SIF_Events, typically Change events, can be reported.

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

StaffMeal()
Constructor

StaffMeal(java.lang.String staffPersonalRefId, EarnedStatus earnedStatus, java.util.Calendar lastBreakfastDate, java.util.Calendar lastLunchDate)
Constructor that accepts values for all mandatory fields

Method Summary

FSAmounts	getAmounts() Gets the value of the <Amounts> element.
EarnedStatus	getEarnedStatus() Gets the value of the <EarnedStatus> 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	getLastBreakfastDate() Gets the value of the <LastBreakfastDate> element.
java.util.Calendar	getLastLunchDate() Gets the value of the <LastLunchDate> element.
java.lang.String	getStaffPersonalRefId() Gets the value of the StaffPersonalRefId attribute.
void	removeAmounts() Removes the Amounts child element previously created by calling setAmounts
void	removeEarnedStatus() Removes the EarnedStatus child element previously created by calling setEarnedStatus
void	setAmounts(FSAmounts value) Sets the value of the <Amounts> element.
void	setEarnedStatus(EarnedStatus value) Sets the value of the <EarnedStatus> element.
void	setEarnedStatus(YesNoNA type) Sets the value of the <EarnedStatus> child element.
void	setLastBreakfastDate(java.util.Calendar value) Sets the value of the <LastBreakfastDate> element.
void	setLastLunchDate(java.util.Calendar value) Sets the value of the <LastLunchDate> element.
void	setStaffPersonalRefId(java.lang.String value) Sets the value of the StaffPersonalRefId attribute.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getRefId, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

StaffMeal

public StaffMeal()

Constructor

StaffMeal

public StaffMeal(java.lang.String staffPersonalRefId,
                 EarnedStatus earnedStatus,
                 java.util.Calendar lastBreakfastDate,
                 java.util.Calendar lastLunchDate)

Constructor that accepts values for all mandatory fields

Parameters:

staffPersonalRefId - The GUID of the staff to whom this object is linked.

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

lastBreakfastDate - Last breakfast served date

lastLunchDate - Last lunch served date

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

getStaffPersonalRefId

public java.lang.String getStaffPersonalRefId()

Gets the value of the StaffPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of the staff to whom this object is linked."

Returns:

The StaffPersonalRefId attribute of this object.

Since:

1.5r1

setStaffPersonalRefId

public void setStaffPersonalRefId(java.lang.String value)

Sets the value of the StaffPersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of the staff to whom this object is linked."

Parameters:

value - A String object

Since:

1.5r1

setEarnedStatus

public void setEarnedStatus(EarnedStatus value)

Sets the value of the <EarnedStatus> element.

The SIF specification defines the meaning of this element as: "This gives information about a staff member's meal status."

Parameters:

value - A EarnedStatus object

Since:

1.5r1

setEarnedStatus

public void setEarnedStatus(YesNoNA type)

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

Parameters:

type - Earned status type.

Since:

1.5r1

getEarnedStatus

public EarnedStatus getEarnedStatus()

Gets the value of the <EarnedStatus> element.

The SIF specification defines the meaning of this element as: "This gives information about a staff member's meal status."

Returns:

An EarnedStatus object

Since:

1.5r1

removeEarnedStatus

public void removeEarnedStatus()

Removes the EarnedStatus child element previously created by calling setEarnedStatus

Since:

1.5r1

getLastBreakfastDate

public java.util.Calendar getLastBreakfastDate()

Gets the value of the <LastBreakfastDate> element.

The SIF specification defines the meaning of this element as: "Last breakfast served date"

Returns:

The LastBreakfastDate element of this object.

Since:

1.5r1

setLastBreakfastDate

public void setLastBreakfastDate(java.util.Calendar value)

Sets the value of the <LastBreakfastDate> element.

The SIF specification defines the meaning of this element as: "Last breakfast served date"

Parameters:

value - A Calendar object

Since:

1.5r1

getLastLunchDate

public java.util.Calendar getLastLunchDate()

Gets the value of the <LastLunchDate> element.

The SIF specification defines the meaning of this element as: "Last lunch served date"

Returns:

The LastLunchDate element of this object.

Since:

1.5r1

setLastLunchDate

public void setLastLunchDate(java.util.Calendar value)

Sets the value of the <LastLunchDate> element.

The SIF specification defines the meaning of this element as: "Last lunch served date"

Parameters:

value - A Calendar object

Since:

1.5r1

setAmounts

public void setAmounts(FSAmounts value)

Sets the value of the <Amounts> element.

Parameters:

value - A FSAmounts object

Since:

1.5r1

getAmounts

public FSAmounts getAmounts()

Gets the value of the <Amounts> element.

Returns:

A FSAmounts object

Since:

1.5r1

removeAmounts

public void removeAmounts()

Removes the Amounts child element previously created by calling setAmounts

Since:

1.5r1