com.edustructures.sifworks.food
Class FoodserviceReimbursementRates

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFDataObject
              extended by com.edustructures.sifworks.food.FoodserviceReimbursementRates
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class FoodserviceReimbursementRates
extends SIFDataObject

This object describes the federal, state, local and other reimbursement rates for a school. 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
FoodserviceReimbursementRates()
          Constructor
FoodserviceReimbursementRates(java.lang.String refId, java.lang.String schoolInfoRefId, java.util.Calendar startDate, java.util.Calendar endDate, Program program, Agencies agencies)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 Agencies getAgencies()
          Gets the value of the <Agencies> element.
 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
 Program getProgram()
          Gets the value of the <Program> element.
 java.lang.String getRefId()
          Gets the value of the RefId attribute.
 java.lang.String getSchoolInfoRefId()
          Gets the value of the <SchoolInfoRefId> element.
 java.util.Calendar getStartDate()
          Gets the value of the <StartDate> element.
 void removeAgencies()
          Removes the Agencies child element previously created by calling setAgencies
 void removeProgram()
          Removes the Program child element previously created by calling setProgram
 void setAgencies(Agencies value)
          Sets the value of the <Agencies> element.
 void setEndDate(java.util.Calendar value)
          Sets the value of the <EndDate> 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 setSchoolInfoRefId(java.lang.String value)
          Sets the value of the <SchoolInfoRefId> element.
 void setStartDate(java.util.Calendar value)
          Sets the value of the <StartDate> 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

FoodserviceReimbursementRates

public FoodserviceReimbursementRates()
Constructor


FoodserviceReimbursementRates

public FoodserviceReimbursementRates(java.lang.String refId,
                                     java.lang.String schoolInfoRefId,
                                     java.util.Calendar startDate,
                                     java.util.Calendar endDate,
                                     Program program,
                                     Agencies agencies)
Constructor that accepts values for all mandatory fields

Parameters:
refId - GUID that identifies this object.
schoolInfoRefId - GUID that identifies the school.
startDate - Effective start date for the reimbursement rates
endDate - Effective end date for the reimbursement rates
program - Refer to 5.1.23 Program.
agencies - Reimbursing agency
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 this 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 this 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: "GUID that identifies the school."

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: "GUID that identifies the school."

Parameters:
value - A String object
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: "Effective start date for the reimbursement rates"

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: "Effective start date for the reimbursement rates"

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: "Effective end date for the reimbursement rates"

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: "Effective end date for the reimbursement rates"

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 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 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

setAgencies

public void setAgencies(Agencies value)
Sets the value of the <Agencies> element.

The SIF specification defines the meaning of this element as: "Reimbursing agency"

Parameters:
value - A Agencies object
Since:
1.5r1

getAgencies

public Agencies getAgencies()
Gets the value of the <Agencies> element.

The SIF specification defines the meaning of this element as: "Reimbursing agency"

Returns:
An Agencies object
Since:
1.5r1

removeAgencies

public void removeAgencies()
Removes the Agencies child element previously created by calling setAgencies

Since:
1.5r1


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.