com.edustructures.sifworks.food
Class Price

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Price
extends SIFKeyedElement

Price of the meal

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

Price()
Constructor

Price(java.math.BigDecimal value, MealStatus mealStatus, MealTypes mealType, GradeLevels gradeLevels)
Constructor that accepts values for all mandatory fields

Method Summary

GradeLevels	getGradeLevels() Gets the value of the <GradeLevels> 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
MealStatus	getMealStatus() Gets the value of the <MealStatus> element.
java.lang.String	getMealType() Gets the value of the <MealType> element.
java.math.BigDecimal	getValue() Gets the value of the Value attribute.
void	removeGradeLevels() Removes the GradeLevels child element previously created by calling setGradeLevels
void	removeMealStatus() Removes the MealStatus child element previously created by calling setMealStatus
void	setGradeLevels(GradeLevels value) Sets the value of the <GradeLevels> element.
void	setMealStatus(FreeReducedStatus type) Sets the value of the <MealStatus> child element.
void	setMealStatus(MealStatus value) Sets the value of the <MealStatus> element.
void	setMealType(MealTypes value) Sets the value of the <MealType> element.
void	setMealType(java.lang.String value) Sets the value of the <MealType> element as a String.
void	setValue(java.math.BigDecimal value) Sets the value of the Value 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

Price

public Price()

Constructor

Price

public Price(java.math.BigDecimal value,
             MealStatus mealStatus,
             MealTypes mealType,
             GradeLevels gradeLevels)

Constructor that accepts values for all mandatory fields

Parameters:

value - The price value

mealStatus - This gives information about a student's meal status.

mealType - This gives information about a meal type

gradeLevels - Refer to section 5.1.12 GradeLevels.

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

getValue

public java.math.BigDecimal getValue()

Gets the value of the Value attribute.

The SIF specification defines the meaning of this attribute as: "The price value"

Returns:

The Value attribute of this object.

Since:

1.5r1

setValue

public void setValue(java.math.BigDecimal value)

Sets the value of the Value attribute.

The SIF specification defines the meaning of this attribute as: "The price value"

Parameters:

value - A BigDecimal object

Since:

1.5r1

setMealStatus

public void setMealStatus(MealStatus value)

Sets the value of the <MealStatus> element.

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

Parameters:

value - A MealStatus object

Since:

1.5r1

setMealStatus

public void setMealStatus(FreeReducedStatus type)

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

Parameters:

type - Meal status type.

Since:

1.5r1

getMealStatus

public MealStatus getMealStatus()

Gets the value of the <MealStatus> element.

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

Returns:

A MealStatus object

Since:

1.5r1

removeMealStatus

public void removeMealStatus()

Removes the MealStatus child element previously created by calling setMealStatus

Since:

1.5r1

getMealType

public java.lang.String getMealType()

Gets the value of the <MealType> element.

The SIF specification defines the meaning of this element as: "This gives information about a meal type"

Returns:

The MealType element of this object.

Since:

1.5r1

setMealType

public void setMealType(MealTypes value)

Sets the value of the <MealType> element.

The SIF specification defines the meaning of this element as: "This gives information about a meal type"

Parameters:

value - A constant defined by the MealTypes class

Since:

1.5r1

setMealType

public void setMealType(java.lang.String value)

Sets the value of the <MealType> element as a String.

The SIF specification defines the meaning of this element as: "This gives information about a meal type"

Parameters:

value - The value as a String

Since:

1.5r1

setGradeLevels

public void setGradeLevels(GradeLevels value)

Sets the value of the <GradeLevels> element.

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

Parameters:

value - A GradeLevels object

Since:

1.5r1

getGradeLevels

public GradeLevels getGradeLevels()

Gets the value of the <GradeLevels> element.

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

Returns:

A GradeLevels object

Since:

1.5r1

removeGradeLevels

public void removeGradeLevels()

Removes the GradeLevels child element previously created by calling setGradeLevels

Since:

1.5r1