com.edustructures.sifworks.food
Class Rates

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Rate>
                  com.edustructures.sifworks.food.Rates

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Rate>, java.util.Collection<Rate>

public class Rates
extends SIFKeyedList<Rate>

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

Rates()
Constructor

Rates(Rate rate)
Constructor that accepts values for all mandatory fields

Method Summary

void	addRate(YesNoNA severeNeed, java.lang.String value, MealStatus mealStatus) Adds a new <Rate> repeatable element.
Rate	getRate(java.lang.String value) Gets a Rate object instance.
Rate[]	getRates() Gets all Rate object instances.
void	removeRate(java.lang.String value) Removes a Rate object instance.
void	setRates(Rate[] rates) Sets an array of Rate objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

Rates

public Rates()

Constructor

Rates

public Rates(Rate rate)

Constructor that accepts values for all mandatory fields

Parameters:

rate - Reimbursement rate of the meal

Method Detail

addRate

public void addRate(YesNoNA severeNeed,
                    java.lang.String value,
                    MealStatus mealStatus)

Adds a new <Rate> repeatable element. This form of setRate is provided as a convenience method that is functionally equivalent to the version of setRate that accepts a single Rate object.

Parameters:

severeNeed - Severe need identifier for the rate. When SevereNeed is Yes then the rate shown is the combined rate. For certain programs the severe need identifier does not apply. In such cases the value NA should be used.

value - The rate value

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

Since:

1.5r1

removeRate

public void removeRate(java.lang.String value)

Removes a Rate object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

value - Identifies the Rate object to remove by its Value value

Since:

1.5r1

getRate

public Rate getRate(java.lang.String value)

Gets a Rate object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

value - Identifies the Rate object to return by its "Value" attribute value

Returns:

A Rate object

Since:

1.5r1

getRates

public Rate[] getRates()

Gets all Rate object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of Rate objects

Since:

1.5r1

setRates

public void setRates(Rate[] rates)

Sets an array of Rate objects. All existing Rate instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all Rates.

Since:

1.5r1