com.edustructures.sifworks.hrfin
Class LocationInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.hrfin.LocationInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LocationInfo
extends SIFDataObject

LocationInfo represents a location in a district. 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

LocationInfo()
Constructor

LocationInfo(java.lang.String refId, LocationInfoType locationType, java.lang.String siteCategory, java.lang.String name, java.lang.String localId)
Constructor that accepts values for all mandatory fields

Method Summary

AddressList	getAddressList() Gets the value of the <AddressList> element.
java.lang.String	getDescription() Gets the value of the <Description> 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
java.lang.String	getLEAInfoRefId() Gets the value of the <LEAInfoRefId> element.
java.lang.String	getLocalId() Gets the value of the <LocalId> element.
java.lang.String	getLocationType() Gets the value of the LocationType attribute.
java.lang.String	getName() Gets the value of the <Name> element.
java.lang.String	getNCESId() Gets the value of the <NCESId> element.
OtherLEAs	getOtherLEAs() Gets the value of the <OtherLEAs> element.
ParentLocationInfo	getParentLocationInfo() Gets the value of the <ParentLocationInfo> element.
PhoneNumberList	getPhoneNumberList() Gets the value of the <PhoneNumberList> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSchoolInfoRefId() Gets the value of the <SchoolInfoRefId> element.
java.lang.String	getSiteCategory() Gets the value of the <SiteCategory> element.
java.lang.String	getStateProvinceId() Gets the value of the <StateProvinceId> element.
void	removeAddressList() Removes the AddressList child element previously created by calling setAddressList
void	removeIdentificationInfoList() Removes the IdentificationInfoList child element previously created by calling setIdentificationInfoList
void	removeOtherLEAs() Removes the OtherLEAs child element previously created by calling setOtherLEAs
void	removeParentLocationInfo() Removes the ParentLocationInfo child element previously created by calling setParentLocationInfo
void	removePhoneNumberList() Removes the PhoneNumberList child element previously created by calling setPhoneNumberList
void	setAddressList(AddressList value) Sets the value of the <AddressList> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setIdentificationInfoList(IdentificationInfoList value) Sets the value of the <IdentificationInfoList> element.
void	setLEAInfoRefId(java.lang.String value) Sets the value of the <LEAInfoRefId> element.
void	setLocalId(java.lang.String value) Sets the value of the <LocalId> element.
void	setLocationType(LocationInfoType value) Sets the value of the LocationType attribute.
void	setLocationType(java.lang.String value) Sets the value of the LocationType attribute as a String.
void	setName(java.lang.String value) Sets the value of the <Name> element.
void	setNCESId(java.lang.String value) Sets the value of the <NCESId> element.
void	setOtherLEAs(OtherLEAs value) Sets the value of the <OtherLEAs> element.
void	setParentLocationInfo(ParentLocationInfo value) Sets the value of the <ParentLocationInfo> element.
void	setParentLocationInfo(java.lang.String sifRefObject, java.lang.String value) Sets the value of the <ParentLocationInfo> child element.
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	setSchoolInfoRefId(java.lang.String value) Sets the value of the <SchoolInfoRefId> element.
void	setSiteCategory(java.lang.String value) Sets the value of the <SiteCategory> element.
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

LocationInfo

public LocationInfo()

Constructor

LocationInfo

public LocationInfo(java.lang.String refId,
                    LocationInfoType locationType,
                    java.lang.String siteCategory,
                    java.lang.String name,
                    java.lang.String localId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The SIF unique identifier for the location.

locationType - Defines whether the location is a school or a non-school location.

siteCategory - Specific site category.

name - Text name of the location

localId - The locally-assigned identifier for this location.

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 SIF unique identifier for the location."

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 SIF unique identifier for the location."

Parameters:

value - A String object

Since:

1.5r1

getLocationType

public java.lang.String getLocationType()

Gets the value of the LocationType attribute.

The SIF specification defines the meaning of this attribute as: "Defines whether the location is a school or a non-school location."

Returns:

The LocationType attribute of this object.

Since:

1.5r1

setLocationType

public void setLocationType(LocationInfoType value)

Sets the value of the LocationType attribute.

The SIF specification defines the meaning of this attribute as: "Defines whether the location is a school or a non-school location."

Parameters:

value - A constant defined by the LocationInfoType class

Since:

1.5r1

setLocationType

public void setLocationType(java.lang.String value)

Sets the value of the LocationType attribute as a String.

The SIF specification defines the meaning of this attribute as: "Defines whether the location is a school or a non-school location."

Parameters:

value - The value as a String

Since:

1.5r1

getSiteCategory

public java.lang.String getSiteCategory()

Gets the value of the <SiteCategory> element.

The SIF specification defines the meaning of this element as: "Specific site category."

Returns:

The SiteCategory element of this object.

Since:

1.5r1

setSiteCategory

public void setSiteCategory(java.lang.String value)

Sets the value of the <SiteCategory> element.

The SIF specification defines the meaning of this element as: "Specific site category."

Parameters:

value - A String object

Since:

1.5r1

getName

public java.lang.String getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Text name of the location"

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	"LocationName"
SIF2.0	"Name"

Returns:

The Name element of this object.

Since:

1.5r1

setName

public void setName(java.lang.String value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Text name of the location"

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	"LocationName"
SIF2.0	"Name"

Parameters:

value - A String object

Since:

1.5r1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Description about the location."

Returns:

The Description element of this object.

Since:

1.5r1

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Description about the location."

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 location."

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 location."

Parameters:

value - A String object

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 a location, 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 a location, 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

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 location."

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 location."

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 location."

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 location.For a description of this element, see 5.1.19 NCESId."

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 location.For a description of this element, see 5.1.19 NCESId."

Parameters:

value - A String object

Since:

1.5r1

getLEAInfoRefId

public java.lang.String getLEAInfoRefId()

Gets the value of the <LEAInfoRefId> element.

The SIF specification defines the meaning of this element as: "The ID (GUID) that identifies the district."

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	"SchoolDistrict"
SIF2.0	"LEAInfoRefId"

Returns:

The LEAInfoRefId element of this object.

Since:

1.5r1

setLEAInfoRefId

public void setLEAInfoRefId(java.lang.String value)

Sets the value of the <LEAInfoRefId> element.

The SIF specification defines the meaning of this element as: "The ID (GUID) that identifies the district."

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	"SchoolDistrict"
SIF2.0	"LEAInfoRefId"

Parameters:

value - A String object

Since:

1.5r1

setOtherLEAs

public void setOtherLEAs(OtherLEAs value)

Sets the value of the <OtherLEAs> element.

The SIF specification defines the meaning of this element as: "Other related education agency, such as a regional service agency."

Parameters:

value - A OtherLEAs object

Since:

1.5r1

getOtherLEAs

public OtherLEAs getOtherLEAs()

Gets the value of the <OtherLEAs> element.

The SIF specification defines the meaning of this element as: "Other related education agency, such as a regional service agency."

Returns:

An OtherLEAs object

Since:

1.5r1

removeOtherLEAs

public void removeOtherLEAs()

Removes the OtherLEAs child element previously created by calling setOtherLEAs

Since:

1.5r1

setParentLocationInfo

public void setParentLocationInfo(ParentLocationInfo value)

Sets the value of the <ParentLocationInfo> element.

The SIF specification defines the meaning of this element as: "A LocationInfo instance could be related to another LocationInfo. This element will help create that relation."

Parameters:

value - A ParentLocationInfo object

Since:

1.5r1

setParentLocationInfo

public void setParentLocationInfo(java.lang.String sifRefObject,
                                  java.lang.String value)

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

Parameters:

sifRefObject - The name of the object referenced.

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

Since:

1.5r1

getParentLocationInfo

public ParentLocationInfo getParentLocationInfo()

Gets the value of the <ParentLocationInfo> element.

The SIF specification defines the meaning of this element as: "A LocationInfo instance could be related to another LocationInfo. This element will help create that relation."

Returns:

A ParentLocationInfo object

Since:

1.5r1

removeParentLocationInfo

public void removeParentLocationInfo()

Removes the ParentLocationInfo child element previously created by calling setParentLocationInfo

Since:

1.5r1

getSchoolInfoRefId

public java.lang.String getSchoolInfoRefId()

Gets the value of the <SchoolInfoRefId> element. 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	"School"
SIF2.0	"SchoolInfoRefId"

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. 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	"School"
SIF2.0	"SchoolInfoRefId"

Parameters:

value - A String object

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: "This element has the LocationInfo address information."

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: "This element has the LocationInfo address information."

Returns:

An AddressList object

Since:

1.5r1

removeAddressList

public void removeAddressList()

Removes the AddressList child element previously created by calling setAddressList

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 location's phone numbers."

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 location's phone numbers."

Returns:

A PhoneNumberList object

Since:

1.5r1

removePhoneNumberList

public void removePhoneNumberList()

Removes the PhoneNumberList child element previously created by calling setPhoneNumberList

Since:

1.5r1