com.edustructures.sifworks.food
Class FoodserviceSales

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FoodserviceSales
extends SIFDataObject

This object communicates the daily sales information (dollar values). SIF_Events are 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

FoodserviceSales()
Constructor

FoodserviceSales(java.lang.String refId, java.lang.String schoolInfoRefId, java.util.Calendar date, Program program, SalesAmounts salesAmounts)
Constructor that accepts values for all mandatory fields

Method Summary

java.util.Calendar	getDate() Gets the value of the <Date> 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
Program	getProgram() Gets the value of the <Program> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
SalesAmounts	getSalesAmounts() Gets the value of the <SalesAmounts> element.
java.lang.String	getSchoolInfoRefId() Gets the value of the <SchoolInfoRefId> element.
void	removeProgram() Removes the Program child element previously created by calling setProgram
void	removeSalesAmounts() Removes the SalesAmounts child element previously created by calling setSalesAmounts
void	setDate(java.util.Calendar value) Sets the value of the <Date> element.
void	setProgram(FinancialProgram type, java.lang.String value) Sets the value of the <Program> child element.
void	setProgram(Program value) Sets the value of the <Program> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSalesAmounts(SalesAmounts value) Sets the value of the <SalesAmounts> element.
void	setSchoolInfoRefId(java.lang.String value) Sets the value of the <SchoolInfoRefId> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, 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

FoodserviceSales

public FoodserviceSales()

Constructor

FoodserviceSales

public FoodserviceSales(java.lang.String refId,
                        java.lang.String schoolInfoRefId,
                        java.util.Calendar date,
                        Program program,
                        SalesAmounts salesAmounts)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID that identifies the daily meal sales object

schoolInfoRefId - School for which the sales object applies

date - Date on which the sales occurred.

program - Refer to section 5.1.23 Program.

salesAmounts -

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies the daily meal sales object"

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.5r1

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that identifies the daily meal sales object"

Parameters:

value - A String object

Since:

1.5r1

getSchoolInfoRefId

public java.lang.String getSchoolInfoRefId()

Gets the value of the <SchoolInfoRefId> element.

The SIF specification defines the meaning of this element as: "School for which the sales object applies"

Returns:

The SchoolInfoRefId element of this object.

Since:

1.5r1

setSchoolInfoRefId

public void setSchoolInfoRefId(java.lang.String value)

Sets the value of the <SchoolInfoRefId> element.

The SIF specification defines the meaning of this element as: "School for which the sales object applies"

Parameters:

value - A String object

Since:

1.5r1

getDate

public java.util.Calendar getDate()

Gets the value of the <Date> element.

The SIF specification defines the meaning of this element as: "Date on which the sales occurred."

Returns:

The Date element of this object.

Since:

1.5r1

setDate

public void setDate(java.util.Calendar value)

Sets the value of the <Date> element.

The SIF specification defines the meaning of this element as: "Date on which the sales occurred."

Parameters:

value - A Calendar object

Since:

1.5r1

setProgram

public void setProgram(Program value)

Sets the value of the <Program> element.

The SIF specification defines the meaning of this element as: "Refer to section 5.1.23 Program."

Parameters:

value - A Program object

Since:

1.5r1

setProgram

public void setProgram(FinancialProgram type,
                       java.lang.String value)

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

Parameters:

type - The type of the program. Type identifies the list of values.

value - Gets or sets the content value of the <Program> element

Since:

1.5r1

getProgram

public Program getProgram()

Gets the value of the <Program> element.

The SIF specification defines the meaning of this element as: "Refer to section 5.1.23 Program."

Returns:

A Program object

Since:

1.5r1

removeProgram

public void removeProgram()

Removes the Program child element previously created by calling setProgram

Since:

1.5r1

setSalesAmounts

public void setSalesAmounts(SalesAmounts value)

Sets the value of the <SalesAmounts> element.

Parameters:

value - A SalesAmounts object

Since:

1.5r1

getSalesAmounts

public SalesAmounts getSalesAmounts()

Gets the value of the <SalesAmounts> element.

Returns:

A SalesAmounts object

Since:

1.5r1

removeSalesAmounts

public void removeSalesAmounts()

Removes the SalesAmounts child element previously created by calling setSalesAmounts

Since:

1.5r1