com.edustructures.sifworks.dw
Class Location

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.dw.Location

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Location
extends SIFKeyedElement

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

Location()
Constructor

Location(LocationType type)
Constructor that accepts values for all mandatory fields

Method Summary

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	getLocationName() Gets the value of the <LocationName> element.
LocationRefId	getLocationRefId() Gets the value of the <LocationRefId> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	removeLocationRefId() Removes the LocationRefId child element previously created by calling setLocationRefId
void	setLocationName(java.lang.String value) Sets the value of the <LocationName> element.
void	setLocationRefId(LocationRefId value) Sets the value of the <LocationRefId> element.
void	setLocationRefId(LocationRefIdObjectName sifRefObject, java.lang.String value) Sets the value of the <LocationRefId> child element.
void	setType(LocationType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.

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

Location

public Location()

Constructor

Location

public Location(LocationType type)

Constructor that accepts values for all mandatory fields

Parameters:

type - Values: Classroom, School, District, Campus, IntermediateUnit, StateEducationAgency

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

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Values: Classroom, School, District, Campus, IntermediateUnit, StateEducationAgency"

Returns:

The Type attribute of this object.

Since:

1.5r1

setType

public void setType(LocationType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Values: Classroom, School, District, Campus, IntermediateUnit, StateEducationAgency"

Parameters:

value - A constant defined by the LocationType class

Since:

1.5r1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: "Values: Classroom, School, District, Campus, IntermediateUnit, StateEducationAgency"

Parameters:

value - The value as a String

Since:

1.5r1

getLocationName

public java.lang.String getLocationName()

Gets the value of the <LocationName> element.

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

Returns:

The LocationName element of this object.

Since:

1.5r1

setLocationName

public void setLocationName(java.lang.String value)

Sets the value of the <LocationName> element.

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

Parameters:

value - A String object

Since:

1.5r1

setLocationRefId

public void setLocationRefId(LocationRefId value)

Sets the value of the <LocationRefId> element.

The SIF specification defines the meaning of this element as: "RefId of the location object if the location is a SIF object such as School (SchoolInfo)"

Parameters:

value - A LocationRefId object

Since:

1.5r1

setLocationRefId

public void setLocationRefId(LocationRefIdObjectName sifRefObject,
                             java.lang.String value)

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

Parameters:

sifRefObject - Type of SIF object Location points to.

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

Since:

1.5r1

getLocationRefId

public LocationRefId getLocationRefId()

Gets the value of the <LocationRefId> element.

The SIF specification defines the meaning of this element as: "RefId of the location object if the location is a SIF object such as School (SchoolInfo)"

Returns:

A LocationRefId object

Since:

1.5r1

removeLocationRefId

public void removeLocationRefId()

Removes the LocationRefId child element previously created by calling setLocationRefId

Since:

1.5r1