com.edustructures.sifworks.reporting
Class StudentLocator

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.reporting.StudentLocator

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StudentLocator
extends SIFDataObject

An example SIF object that serves as a template for matching objects. There is an implied EQ operator for every element/attribute value present and an implied And group of all resulting conditions. Currently this is an experimental feature and limited to use with StudentLocator; wider use may be considered in future major versions of this specification.

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

StudentLocator()
Constructor

StudentLocator(IdStatus idStatus, StatePrCode stateProvinceId, java.lang.String transactionId)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAddress(Address value) Adds a new <Address> child element.
void	addAddress(AddressType type, Street street, java.lang.String city, StatePrCode stateProvince, CountryCode country, java.lang.String postalCode) Adds a new <Address> repeatable element.
void	addContact(Relationship relationship) Adds a new <Contact> repeatable element.
void	addContact(SLContact value) Adds a new <Contact> child element.
void	addName(Name value) Adds a new <Name> child element.
void	addName(NameType type, java.lang.String lastName, java.lang.String firstName) Adds a new <Name> repeatable element.
void	addRequestingAgencyId(RequestingAgencyId value) Adds a new <RequestingAgencyId> child element.
void	addRequestingAgencyId(RequestingAgencyIdType type, java.lang.String value) Adds a new <RequestingAgencyId> repeatable element.
Address	getAddress(AddressType type) Gets an Address object instance.
Address[]	getAddresses() Gets all Address object instances.
java.lang.String	getConfidence() Gets the value of the <Confidence> element.
SLContact	getContact(Relationship relationship) Gets a SLContact object instance.
SLContact[]	getContacts() Gets all SLContact object instances.
Demographics	getDemographics() Gets the value of the <Demographics> element.
java.util.Calendar	getEffectiveDate() Gets the value of the <EffectiveDate> element.
java.util.Calendar	getEndDate() Gets the value of the <EndDate> element.
GradeLevel	getGradeLevel() Gets the value of the <GradeLevel> element.
PartialDateType	getGraduationDate() Gets the value of the <GraduationDate> element.
java.lang.String	getIdStatus() Gets the value of the IdStatus attribute.
java.lang.String	getLocalId() Gets the value of the <LocalId> element.
Name	getName(NameType type) Gets a Name object instance.
Name[]	getNames() Gets all Name object instances.
OtherId	getOtherId() Gets the value of the <OtherId> element.
RequestingAgencyId	getRequestingAgencyId(RequestingAgencyIdType type) Gets a RequestingAgencyId object instance.
RequestingAgencyId[]	getRequestingAgencyIds() Gets all RequestingAgencyId object instances.
java.lang.String	getSchoolAttendedLocation() Gets the value of the <SchoolAttendedLocation> element.
java.lang.String	getSchoolAttendedName() Gets the value of the <SchoolAttendedName> element.
SIF_Error	getSIF_Error() Gets the value of the <SIF_Error> element.
java.lang.String	getSSN() Gets the value of the <SSN> element.
java.util.Calendar	getStartDate() Gets the value of the <StartDate> element.
java.lang.String	getStateProvinceId() Gets the value of the <StateProvinceId> element.
java.lang.String	getStudentPersonalRefId() Gets the value of the <StudentPersonalRefId> element.
java.lang.String	getTransactionId() Gets the value of the TransactionId attribute.
void	removeAddress(AddressType type) Removes an Address object instance.
void	removeContact(Relationship relationship) Removes a SLContact object instance.
void	removeDemographics() Removes the Demographics child element previously created by calling setDemographics
void	removeGradeLevel() Removes the GradeLevel child element previously created by calling setGradeLevel
void	removeGraduationDate() Removes the GraduationDate child element previously created by calling setGraduationDate
void	removeName(NameType type) Removes a Name object instance.
void	removeOtherId() Removes the OtherId child element previously created by calling setOtherId
void	removeRequestingAgencyId(RequestingAgencyIdType type) Removes a RequestingAgencyId object instance.
void	removeSIF_Error() Removes the SIF_Error child element previously created by calling setSIF_Error
void	setAddresses(Address[] addresses) Sets an array of Address objects.
void	setConfidence(java.lang.String value) Sets the value of the <Confidence> element.
void	setContacts(SLContact[] contacts) Sets an array of SLContact objects.
void	setDemographics(Demographics value) Sets the value of the <Demographics> element.
void	setEffectiveDate(java.util.Calendar value) Sets the value of the <EffectiveDate> element.
void	setEndDate(java.util.Calendar value) Sets the value of the <EndDate> element.
void	setGradeLevel(GradeLevel value) Sets the value of the <GradeLevel> element.
void	setGradeLevel(GradeLevelCode code) Sets the value of the <GradeLevel> child element.
void	setGraduationDate(PartialDateType value) Sets the value of the <GraduationDate> element.
void	setGraduationDate(java.lang.String value) Sets the value of the <GraduationDate> child element.
void	setIdStatus(IdStatus value) Sets the value of the IdStatus attribute.
void	setIdStatus(java.lang.String value) Sets the value of the IdStatus attribute as a String.
void	setLocalId(java.lang.String value) Sets the value of the <LocalId> element.
void	setNames(Name[] names) Sets an array of Name objects.
void	setOtherId(OtherId value) Sets the value of the <OtherId> element.
void	setOtherId(OtherIdType type, java.lang.String value) Sets the value of the <OtherId> child element.
void	setRequestingAgencyIds(RequestingAgencyId[] requestingagencyids) Sets an array of RequestingAgencyId objects.
void	setSchoolAttendedLocation(java.lang.String value) Sets the value of the <SchoolAttendedLocation> element.
void	setSchoolAttendedName(java.lang.String value) Sets the value of the <SchoolAttendedName> element.
void	setSIF_Error(java.lang.Integer sifCategory, java.lang.Integer sifCode, java.lang.String sifDesc) Sets the value of the <SIF_Error> child element.
void	setSIF_Error(SIF_Error value) Sets the value of the <SIF_Error> element.
void	setSSN(java.lang.String value) Sets the value of the <SSN> element.
void	setStartDate(java.util.Calendar value) Sets the value of the <StartDate> 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.
void	setStudentPersonalRefId(java.lang.String value) Sets the value of the <StudentPersonalRefId> element.
void	setTransactionId(java.lang.String value) Sets the value of the TransactionId attribute.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getRefId, 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, getKey, 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

StudentLocator

public StudentLocator()

Constructor

StudentLocator

public StudentLocator(IdStatus idStatus,
                      StatePrCode stateProvinceId,
                      java.lang.String transactionId)

Constructor that accepts values for all mandatory fields

Parameters:

idStatus - Communicates the orchestration status for the object.

stateProvinceId - This is the student's state-assigned ID. May be empty in a response where IdStatus is "Ambiguous."

transactionId - GUID that allows requesters and responders to refer to the same logical StudentLocator "transaction" over more than one SIF_Request/SIF_Response exchange.

Method Detail

getIdStatus

public java.lang.String getIdStatus()

Gets the value of the IdStatus attribute.

The SIF specification defines the meaning of this attribute as: "Communicates the orchestration status for the object."

Returns:

The IdStatus attribute of this object.

Since:

1.5r1

setIdStatus

public void setIdStatus(IdStatus value)

Sets the value of the IdStatus attribute.

The SIF specification defines the meaning of this attribute as: "Communicates the orchestration status for the object."

Parameters:

value - A constant defined by the IdStatus class

Since:

1.5r1

setIdStatus

public void setIdStatus(java.lang.String value)

Sets the value of the IdStatus attribute as a String.

The SIF specification defines the meaning of this attribute as: "Communicates the orchestration status for the object."

Parameters:

value - The value as a String

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: "This is the student's state-assigned ID. May be empty in a response where IdStatus is "Ambiguous.""

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: "This is the student's state-assigned ID. May be empty in a response where IdStatus is "Ambiguous.""

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: "This is the student's state-assigned ID. May be empty in a response where IdStatus is "Ambiguous.""

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

getTransactionId

public java.lang.String getTransactionId()

Gets the value of the TransactionId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that allows requesters and responders to refer to the same logical StudentLocator "transaction" over more than one SIF_Request/SIF_Response exchange."

Returns:

The TransactionId attribute of this object.

Since:

2.0

setTransactionId

public void setTransactionId(java.lang.String value)

Sets the value of the TransactionId attribute.

The SIF specification defines the meaning of this attribute as: "GUID that allows requesters and responders to refer to the same logical StudentLocator "transaction" over more than one SIF_Request/SIF_Response exchange."

Parameters:

value - A String object

Since:

2.0

getConfidence

public java.lang.String getConfidence()

Gets the value of the <Confidence> element.

The SIF specification defines the meaning of this element as: "Confidence score. The main use of this element is when IdStatus equals "Ambiguous" and the state returns one or more* candidate matches. The interpretation is that the information populated in each returned object matches the information in the request to the extent expressed in this score. The matching/scoring algorithms (and resultant values) are defined by the particular state."

Returns:

The Confidence element of this object.

Since:

1.5r1

setConfidence

public void setConfidence(java.lang.String value)

Sets the value of the <Confidence> element.

The SIF specification defines the meaning of this element as: "Confidence score. The main use of this element is when IdStatus equals "Ambiguous" and the state returns one or more* candidate matches. The interpretation is that the information populated in each returned object matches the information in the request to the extent expressed in this score. The matching/scoring algorithms (and resultant values) are defined by the particular state."

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: "This is the requesting agency's unique ID for the student."

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: "This is the requesting agency's unique ID for the student."

Parameters:

value - A String object

Since:

1.5r1

getStudentPersonalRefId

public java.lang.String getStudentPersonalRefId()

Gets the value of the <StudentPersonalRefId> element.

The SIF specification defines the meaning of this element as: "Requesting agency's local zone GUID of the student's StudentPersonal object."

Returns:

The StudentPersonalRefId element of this object.

Since:

1.5r1

setStudentPersonalRefId

public void setStudentPersonalRefId(java.lang.String value)

Sets the value of the <StudentPersonalRefId> element.

The SIF specification defines the meaning of this element as: "Requesting agency's local zone GUID of the student's StudentPersonal object."

Parameters:

value - A String object

Since:

1.5r1

addRequestingAgencyId

public void addRequestingAgencyId(RequestingAgencyId value)

Adds a new <RequestingAgencyId> child element.

The SIF specification defines the meaning of this element as: "Identification of the agency and/or location requesting the state ID. Optional because the SIF Zone infrastructure may provide adequate information for the state to ascertain the origin of the request."

Parameters:

value - A RequestingAgencyId object

Since:

1.5r1

addRequestingAgencyId

public void addRequestingAgencyId(RequestingAgencyIdType type,
                                  java.lang.String value)

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

Parameters:

type - The functional level of the requesting agency.

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

Since:

1.5r1

removeRequestingAgencyId

public void removeRequestingAgencyId(RequestingAgencyIdType type)

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

Parameters:

type - Identifies the RequestingAgencyId object to remove by its Type value

Since:

1.5r1

getRequestingAgencyId

public RequestingAgencyId getRequestingAgencyId(RequestingAgencyIdType type)

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

Parameters:

type - Identifies the RequestingAgencyId object to return by its "Type" attribute value

Returns:

A RequestingAgencyId object

Since:

1.5r1

getRequestingAgencyIds

public RequestingAgencyId[] getRequestingAgencyIds()

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

Returns:

An array of RequestingAgencyId objects

Since:

1.5r1

setRequestingAgencyIds

public void setRequestingAgencyIds(RequestingAgencyId[] requestingagencyids)

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

Since:

1.5r1

setGradeLevel

public void setGradeLevel(GradeLevel value)

Sets the value of the <GradeLevel> element.

The SIF specification defines the meaning of this element as: "The student's current grade level."

Parameters:

value - A GradeLevel object

Since:

1.5r1

setGradeLevel

public void setGradeLevel(GradeLevelCode code)

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

Parameters:

code - Code representing the grade level.

Since:

1.5r1

getGradeLevel

public GradeLevel getGradeLevel()

Gets the value of the <GradeLevel> element.

The SIF specification defines the meaning of this element as: "The student's current grade level."

Returns:

A GradeLevel object

Since:

1.5r1

removeGradeLevel

public void removeGradeLevel()

Removes the GradeLevel child element previously created by calling setGradeLevel

Since:

1.5r1

getSSN

public java.lang.String getSSN()

Gets the value of the <SSN> element.

The SIF specification defines the meaning of this element as: "Social security number of the student."

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	"Ssn"
SIF2.0	"SSN"

Returns:

The SSN element of this object.

Since:

1.5r1

setSSN

public void setSSN(java.lang.String value)

Sets the value of the <SSN> element.

The SIF specification defines the meaning of this element as: "Social security number of the student."

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	"Ssn"
SIF2.0	"SSN"

Parameters:

value - A String object

Since:

1.5r1

addName

public void addName(Name value)

Adds a new <Name> child element.

The SIF specification defines the meaning of this element as: "The name(s) of the student."

Parameters:

value - A Name object

Since:

1.5r1

addName

public void addName(NameType type,
                    java.lang.String lastName,
                    java.lang.String firstName)

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

Parameters:

type - Code that specifies what type of name this is. If unsure, use 04.

lastName - The last name.

firstName - The first name.

Since:

1.5r1

removeName

public void removeName(NameType type)

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

Parameters:

type - Identifies the Name object to remove by its Type value

Since:

1.5r1

getName

public Name getName(NameType type)

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

Parameters:

type - Identifies the Name object to return by its "Type" attribute value

Returns:

A Name object

Since:

1.5r1

getNames

public Name[] getNames()

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

Returns:

An array of Name objects

Since:

1.5r1

setNames

public void setNames(Name[] names)

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

Since:

1.5r1

addAddress

public void addAddress(Address value)

Adds a new <Address> child element.

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

Parameters:

value - A Address object

Since:

1.5r1

addAddress

public void addAddress(AddressType type,
                       Street street,
                       java.lang.String city,
                       StatePrCode stateProvince,
                       CountryCode country,
                       java.lang.String postalCode)

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

Parameters:

type - Code that defines the location of the address. Note: A subset of specific valid values for each instance in a data object may be listed in that object.

street - The street part of the address

city - The city part of the address.

stateProvince - The state or province code.

country - The country code.

postalCode - The ZIP/postal code.

Since:

1.5r1

removeAddress

public void removeAddress(AddressType type)

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

Parameters:

type - Identifies the Address object to remove by its Type value

Since:

1.5r1

getAddress

public Address getAddress(AddressType type)

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

Parameters:

type - Identifies the Address object to return by its "Type" attribute value

Returns:

An Address object

Since:

1.5r1

getAddresses

public Address[] getAddresses()

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

Returns:

An array of Address objects

Since:

1.5r1

setAddresses

public void setAddresses(Address[] addresses)

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

Since:

1.5r1

setDemographics

public void setDemographics(Demographics value)

Sets the value of the <Demographics> element.

The SIF specification defines the meaning of this element as: "Demographic information about the student. This will typically be the core matching information. Privacy considerations may mean that it is filled differently here than it might be in a local StudentPersonal, but it must include enough to drive the state's matching algorithms."

Parameters:

value - A Demographics object

Since:

1.5r1

getDemographics

public Demographics getDemographics()

Gets the value of the <Demographics> element.

The SIF specification defines the meaning of this element as: "Demographic information about the student. This will typically be the core matching information. Privacy considerations may mean that it is filled differently here than it might be in a local StudentPersonal, but it must include enough to drive the state's matching algorithms."

Returns:

A Demographics object

Since:

1.5r1

removeDemographics

public void removeDemographics()

Removes the Demographics child element previously created by calling setDemographics

Since:

1.5r1

addContact

public void addContact(SLContact value)

Adds a new <Contact> child element.

The SIF specification defines the meaning of this element as: "Typically used to provide the state information about a student's parents and legal guardians."

Parameters:

value - A SLContact object

Since:

1.5r1

addContact

public void addContact(Relationship relationship)

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

Parameters:

relationship - Relationship to the student.

Since:

1.5r1

removeContact

public void removeContact(Relationship relationship)

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

Parameters:

relationship - Identifies the SLContact object to remove by its Relationship value

Since:

1.5r1

getContact

public SLContact getContact(Relationship relationship)

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

Parameters:

relationship - Identifies the SLContact object to return by its "Relationship" attribute value

Returns:

A SLContact object

Since:

1.5r1

getContacts

public SLContact[] getContacts()

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

Returns:

An array of SLContact objects

Since:

1.5r1

setContacts

public void setContacts(SLContact[] contacts)

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

Since:

1.5r1

getEffectiveDate

public java.util.Calendar getEffectiveDate()

Gets the value of the <EffectiveDate> element.

The SIF specification defines the meaning of this element as: "For Requests, this should match StudentSchoolEnrollment/EntryDate."

Returns:

The EffectiveDate element of this object.

Since:

1.5r1

setEffectiveDate

public void setEffectiveDate(java.util.Calendar value)

Sets the value of the <EffectiveDate> element.

The SIF specification defines the meaning of this element as: "For Requests, this should match StudentSchoolEnrollment/EntryDate."

Parameters:

value - A Calendar object

Since:

1.5r1

getStartDate

public java.util.Calendar getStartDate()

Gets the value of the <StartDate> element.

Returns:

The StartDate element of this object.

Since:

2.0

setStartDate

public void setStartDate(java.util.Calendar value)

Sets the value of the <StartDate> element.

Parameters:

value - A Calendar object

Since:

2.0

getEndDate

public java.util.Calendar getEndDate()

Gets the value of the <EndDate> element.

Returns:

The EndDate element of this object.

Since:

2.0

setEndDate

public void setEndDate(java.util.Calendar value)

Sets the value of the <EndDate> element.

Parameters:

value - A Calendar object

Since:

2.0

setGraduationDate

public void setGraduationDate(PartialDateType value)

Sets the value of the <GraduationDate> element.

The SIF specification defines the meaning of this element as: "Indicates the date the student graduated--GradYear, GradYear and GradMonth, or GradYear, GradMonth and GradDay may be specified. Intended to facilitate locating students that may not be currently enrolled in a school or district, particularly in the context of locating student identifiers for initiating a request for a student's academic record. Supplied date values may often be approximations made by the entity endeavoring to request a student's academic record."

Parameters:

value - A PartialDateType object

Since:

2.0

setGraduationDate

public void setGraduationDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getGraduationDate

public PartialDateType getGraduationDate()

Gets the value of the <GraduationDate> element.

The SIF specification defines the meaning of this element as: "Indicates the date the student graduated--GradYear, GradYear and GradMonth, or GradYear, GradMonth and GradDay may be specified. Intended to facilitate locating students that may not be currently enrolled in a school or district, particularly in the context of locating student identifiers for initiating a request for a student's academic record. Supplied date values may often be approximations made by the entity endeavoring to request a student's academic record."

Returns:

A PartialDateType object

Since:

2.0

removeGraduationDate

public void removeGraduationDate()

Removes the GraduationDate child element previously created by calling setGraduationDate

Since:

2.0

getSchoolAttendedName

public java.lang.String getSchoolAttendedName()

Gets the value of the <SchoolAttendedName> element.

The SIF specification defines the meaning of this element as: "The name of the school last attended by the student."

Returns:

The SchoolAttendedName element of this object.

Since:

2.0

setSchoolAttendedName

public void setSchoolAttendedName(java.lang.String value)

Sets the value of the <SchoolAttendedName> element.

The SIF specification defines the meaning of this element as: "The name of the school last attended by the student."

Parameters:

value - A String object

Since:

2.0

getSchoolAttendedLocation

public java.lang.String getSchoolAttendedLocation()

Gets the value of the <SchoolAttendedLocation> element.

The SIF specification defines the meaning of this element as: "The location of the school last attended by the student (e.g. city or county name, district name, etc.)."

Returns:

The SchoolAttendedLocation element of this object.

Since:

2.0

setSchoolAttendedLocation

public void setSchoolAttendedLocation(java.lang.String value)

Sets the value of the <SchoolAttendedLocation> element.

The SIF specification defines the meaning of this element as: "The location of the school last attended by the student (e.g. city or county name, district name, etc.)."

Parameters:

value - A String object

Since:

2.0

setOtherId

public void setOtherId(OtherId value)

Sets the value of the <OtherId> element.

The SIF specification defines the meaning of this element as: "Additional student identifier not represented elsewhere in StudentLocator (e.g. the driver's license number of the student)."

Parameters:

value - A OtherId object

Since:

2.0

setOtherId

public void setOtherId(OtherIdType type,
                       java.lang.String value)

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

Parameters:

type - Code that defines the type of this other ID. Note: A subset of valid values may be specified in data objects.

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

Since:

2.0

getOtherId

public OtherId getOtherId()

Gets the value of the <OtherId> element.

The SIF specification defines the meaning of this element as: "Additional student identifier not represented elsewhere in StudentLocator (e.g. the driver's license number of the student)."

Returns:

An OtherId object

Since:

2.0

removeOtherId

public void removeOtherId()

Removes the OtherId child element previously created by calling setOtherId

Since:

2.0

setSIF_Error

public void setSIF_Error(SIF_Error value)

Sets the value of the <SIF_Error> element.

The SIF specification defines the meaning of this element as: "When IdStatus is set to Error, this element provides details about the error. Rather than the specification defining a list of possible error categories and codes for StudentLocator transactions, the SIF_Category and SIF_Code elements may contain values defined by the application that is responding to the StudentLocator request. It is recommended the requester convey these values in log files or error reports, along with the SIF_Desc and optional SIF_ExtendedDesc elements."

Parameters:

value - A SIF_Error object

Since:

2.0

setSIF_Error

public void setSIF_Error(java.lang.Integer sifCategory,
                         java.lang.Integer sifCode,
                         java.lang.String sifDesc)

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

Parameters:

sifCategory -

sifCode - See Error Codes.

sifDesc - A simple, easy to understand, description of the error. The primary consumer of this message is the application user. Example: "Unable to open database."

Since:

2.0

getSIF_Error

public SIF_Error getSIF_Error()

Gets the value of the <SIF_Error> element.

The SIF specification defines the meaning of this element as: "When IdStatus is set to Error, this element provides details about the error. Rather than the specification defining a list of possible error categories and codes for StudentLocator transactions, the SIF_Category and SIF_Code elements may contain values defined by the application that is responding to the StudentLocator request. It is recommended the requester convey these values in log files or error reports, along with the SIF_Desc and optional SIF_ExtendedDesc elements."

Returns:

A SIF_Error object

Since:

2.0

removeSIF_Error

public void removeSIF_Error()

Removes the SIF_Error child element previously created by calling setSIF_Error

Since:

2.0