com.edustructures.sifworks.student
Class LEAInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.student.LEAInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LEAInfo
extends SIFDataObject

This object contains information about a school district or other Local Educational Agency (LEA). 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

LEAInfo()
Constructor

LEAInfo(java.lang.String refId, java.lang.String leaName)
Constructor that accepts values for all mandatory fields

Method Summary

AddressList	getAddressList() Gets the value of the <AddressList> element.
java.lang.String	getCongressionalDistrict() Gets the value of the <CongressionalDistrict> element.
EducationAgencyType	getEducationAgencyType() Gets the value of the <EducationAgencyType> element.
GradeLevels	getGradeLevels() Gets the value of the <GradeLevels> element.
IdentificationInfoList	getIdentificationInfoList() Gets the value of the <IdentificationInfoList> 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
LEAContactList	getLEAContactList() Gets the value of the <LEAContactList> element.
java.lang.String	getLEAName() Gets the value of the <LEAName> element.
java.lang.String	getLEAURL() Gets the value of the <LEAURL> element.
java.lang.String	getLocalId() Gets the value of the <LocalId> element.
java.lang.String	getNCESId() Gets the value of the <NCESId> element.
java.lang.String	getOperationalStatus() Gets the value of the <OperationalStatus> element.
PhoneNumberList	getPhoneNumberList() Gets the value of the <PhoneNumberList> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getStateProvinceId() Gets the value of the <StateProvinceId> element.
void	removeAddressList() Removes the AddressList child element previously created by calling setAddressList
void	removeEducationAgencyType() Removes the EducationAgencyType child element previously created by calling setEducationAgencyType
void	removeGradeLevels() Removes the GradeLevels child element previously created by calling setGradeLevels
void	removeIdentificationInfoList() Removes the IdentificationInfoList child element previously created by calling setIdentificationInfoList
void	removeLEAContactList() Removes the LEAContactList child element previously created by calling setLEAContactList
void	removePhoneNumberList() Removes the PhoneNumberList child element previously created by calling setPhoneNumberList
void	setAddressList(AddressList value) Sets the value of the <AddressList> element.
void	setCongressionalDistrict(java.lang.String value) Sets the value of the <CongressionalDistrict> element.
void	setEducationAgencyType(EducationAgencyType value) Sets the value of the <EducationAgencyType> element.
void	setEducationAgencyType(EducationAgencyTypeCode code) Sets the value of the <EducationAgencyType> child element.
void	setGradeLevels(GradeLevels value) Sets the value of the <GradeLevels> element.
void	setIdentificationInfoList(IdentificationInfoList value) Sets the value of the <IdentificationInfoList> element.
void	setLEAContactList(LEAContactList value) Sets the value of the <LEAContactList> element.
void	setLEAName(java.lang.String value) Sets the value of the <LEAName> element.
void	setLEAURL(java.lang.String value) Sets the value of the <LEAURL> element.
void	setLocalId(java.lang.String value) Sets the value of the <LocalId> element.
void	setNCESId(java.lang.String value) Sets the value of the <NCESId> element.
void	setOperationalStatus(OperationalStatus value) Sets the value of the <OperationalStatus> element.
void	setOperationalStatus(java.lang.String value) Sets the value of the <OperationalStatus> element as a String.
void	setPhoneNumberList(PhoneNumberList value) Sets the value of the <PhoneNumberList> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setStateProvinceId(StatePrCode value) Sets the value of the <StateProvinceId> element.
void	setStateProvinceId(java.lang.String value) Sets the value of the <StateProvinceId> element as a String.

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

LEAInfo

public LEAInfo()

Constructor

LEAInfo

public LEAInfo(java.lang.String refId,
               java.lang.String leaName)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The GUID of the LEA whose information this is.

leaName - Name of LEA.

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: "The GUID of the LEA whose information this is."

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: "The GUID of the LEA whose information this is."

Parameters:

value - A String object

Since:

1.5r1

getLocalId

public java.lang.String getLocalId()

Gets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: "The locally-assigned identifier for this LEA."

Returns:

The LocalId element of this object.

Since:

1.5r1

setLocalId

public void setLocalId(java.lang.String value)

Sets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: "The locally-assigned identifier for this LEA."

Parameters:

value - A String object

Since:

1.5r1

getStateProvinceId

public java.lang.String getStateProvinceId()

Gets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "The state-assigned identifier for this LEA."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"StatePrId"
SIF2.0	"StateProvinceId"

Returns:

The StateProvinceId element of this object.

Since:

1.5r1

setStateProvinceId

public void setStateProvinceId(StatePrCode value)

Sets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "The state-assigned identifier for this LEA."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"StatePrId"
SIF2.0	"StateProvinceId"

Parameters:

value - A constant defined by the StatePrCode class

Since:

1.5r1

setStateProvinceId

public void setStateProvinceId(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "The state-assigned identifier for this LEA."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"StatePrId"
SIF2.0	"StateProvinceId"

Parameters:

value - The value as a String

Since:

1.5r1

getNCESId

public java.lang.String getNCESId()

Gets the value of the <NCESId> element.

The SIF specification defines the meaning of this element as: "The NCES-assigned identifier for this LEA."

Returns:

The NCESId element of this object.

Since:

1.5r1

setNCESId

public void setNCESId(java.lang.String value)

Sets the value of the <NCESId> element.

The SIF specification defines the meaning of this element as: "The NCES-assigned identifier for this LEA."

Parameters:

value - A String object

Since:

1.5r1

getLEAName

public java.lang.String getLEAName()

Gets the value of the <LEAName> element.

The SIF specification defines the meaning of this element as: "Name of LEA."

Returns:

The LEAName element of this object.

Since:

1.5r1

setLEAName

public void setLEAName(java.lang.String value)

Sets the value of the <LEAName> element.

The SIF specification defines the meaning of this element as: "Name of LEA."

Parameters:

value - A String object

Since:

1.5r1

getLEAURL

public java.lang.String getLEAURL()

Gets the value of the <LEAURL> element.

The SIF specification defines the meaning of this element as: "URL for the LEA."

Returns:

The LEAURL element of this object.

Since:

1.5r1

setLEAURL

public void setLEAURL(java.lang.String value)

Sets the value of the <LEAURL> element.

The SIF specification defines the meaning of this element as: "URL for the LEA."

Parameters:

value - A String object

Since:

1.5r1

setEducationAgencyType

public void setEducationAgencyType(EducationAgencyType value)

Sets the value of the <EducationAgencyType> element.

The SIF specification defines the meaning of this element as: "The classification of the education agency within the geographic boundaries of a state according to the level of administrative and operational control."

Parameters:

value - A EducationAgencyType object

Since:

1.5r1

setEducationAgencyType

public void setEducationAgencyType(EducationAgencyTypeCode code)

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

Parameters:

code - Code indicating the operational/administrative level.

Since:

1.5r1

getEducationAgencyType

public EducationAgencyType getEducationAgencyType()

Gets the value of the <EducationAgencyType> element.

The SIF specification defines the meaning of this element as: "The classification of the education agency within the geographic boundaries of a state according to the level of administrative and operational control."

Returns:

An EducationAgencyType object

Since:

1.5r1

removeEducationAgencyType

public void removeEducationAgencyType()

Removes the EducationAgencyType child element previously created by calling setEducationAgencyType

Since:

1.5r1

setLEAContactList

public void setLEAContactList(LEAContactList value)

Sets the value of the <LEAContactList> element.

The SIF specification defines the meaning of this element as: "Information on contact persons for this LEA."

Parameters:

value - A LEAContactList object

Since:

1.5r1

getLEAContactList

public LEAContactList getLEAContactList()

Gets the value of the <LEAContactList> element.

The SIF specification defines the meaning of this element as: "Information on contact persons for this LEA."

Returns:

A LEAContactList object

Since:

1.5r1

removeLEAContactList

public void removeLEAContactList()

Removes the LEAContactList child element previously created by calling setLEAContactList

Since:

1.5r1

setPhoneNumberList

public void setPhoneNumberList(PhoneNumberList value)

Sets the value of the <PhoneNumberList> element.

The SIF specification defines the meaning of this element as: "The LEA's phone number(s)."

Parameters:

value - A PhoneNumberList object

Since:

1.5r1

getPhoneNumberList

public PhoneNumberList getPhoneNumberList()

Gets the value of the <PhoneNumberList> element.

The SIF specification defines the meaning of this element as: "The LEA's phone number(s)."

Returns:

A PhoneNumberList object

Since:

1.5r1

removePhoneNumberList

public void removePhoneNumberList()

Removes the PhoneNumberList child element previously created by calling setPhoneNumberList

Since:

1.5r1

setAddressList

public void setAddressList(AddressList value)

Sets the value of the <AddressList> element.

The SIF specification defines the meaning of this element as: "The LEA's address(es)."

Parameters:

value - A AddressList object

Since:

1.5r1

getAddressList

public AddressList getAddressList()

Gets the value of the <AddressList> element.

The SIF specification defines the meaning of this element as: "The LEA's address(es)."

Returns:

An AddressList object

Since:

1.5r1

removeAddressList

public void removeAddressList()

Removes the AddressList child element previously created by calling setAddressList

Since:

1.5r1

setIdentificationInfoList

public void setIdentificationInfoList(IdentificationInfoList value)

Sets the value of the <IdentificationInfoList> element.

The SIF specification defines the meaning of this element as: "Other identification information associated with an LEA, such as the locally-defined code/identifier, etc."

Parameters:

value - A IdentificationInfoList object

Since:

1.5r1

getIdentificationInfoList

public IdentificationInfoList getIdentificationInfoList()

Gets the value of the <IdentificationInfoList> element.

The SIF specification defines the meaning of this element as: "Other identification information associated with an LEA, such as the locally-defined code/identifier, etc."

Returns:

An IdentificationInfoList object

Since:

1.5r1

removeIdentificationInfoList

public void removeIdentificationInfoList()

Removes the IdentificationInfoList child element previously created by calling setIdentificationInfoList

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: "Collection of grade levels offered in this LEA."

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: "Collection of grade levels offered in this LEA."

Returns:

A GradeLevels object

Since:

1.5r1

removeGradeLevels

public void removeGradeLevels()

Removes the GradeLevels child element previously created by calling setGradeLevels

Since:

1.5r1

getOperationalStatus

public java.lang.String getOperationalStatus()

Gets the value of the <OperationalStatus> element.

The SIF specification defines the meaning of this element as: "Operational condition of an LEA."

Returns:

The OperationalStatus element of this object.

Since:

1.5r1

setOperationalStatus

public void setOperationalStatus(OperationalStatus value)

Sets the value of the <OperationalStatus> element.

The SIF specification defines the meaning of this element as: "Operational condition of an LEA."

Parameters:

value - A constant defined by the OperationalStatus class

Since:

1.5r1

setOperationalStatus

public void setOperationalStatus(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Operational condition of an LEA."

Parameters:

value - The value as a String

Since:

1.5r1

getCongressionalDistrict

public java.lang.String getCongressionalDistrict()

Gets the value of the <CongressionalDistrict> element.

The SIF specification defines the meaning of this element as: "Number for the US congressional district where the LEA is located."

Returns:

The CongressionalDistrict element of this object.

Since:

1.5r1

setCongressionalDistrict

public void setCongressionalDistrict(java.lang.String value)

Sets the value of the <CongressionalDistrict> element.

The SIF specification defines the meaning of this element as: "Number for the US congressional district where the LEA is located."

Parameters:

value - A String object

Since:

1.5r1