com.edustructures.sifworks.common
Class Demographics

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.common.Demographics

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Demographics
extends SIFElement

Demographics about a student, contact, staff member, etc.

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Demographics()
Constructor

Method Summary

java.util.Calendar	getBirthDate() Gets the value of the <BirthDate> element.
java.lang.String	getBirthDateVerification() Gets the value of the <BirthDateVerification> element.
java.lang.String	getCitizenshipStatus() Gets the value of the <CitizenshipStatus> element.
CountriesOfCitizenship	getCountriesOfCitizenship() Gets the value of the <CountriesOfCitizenship> element.
CountriesOfResidency	getCountriesOfResidency() Gets the value of the <CountriesOfResidency> element.
java.util.Calendar	getCountryArrivalDate() Gets the value of the <CountryArrivalDate> element.
java.lang.String	getCountryOfBirth() Gets the value of the <CountryOfBirth> element.
java.lang.String	getCountyOfBirth() Gets the value of the <CountyOfBirth> element.
DwellingArrangement	getDwellingArrangement() Gets the value of the <DwellingArrangement> element.
EnglishProficiency	getEnglishProficiency() Gets the value of the <EnglishProficiency> element.
java.lang.String	getGender() Gets the value of the <Gender> element.
java.lang.String	getHispanicLatino() Gets the value of the <HispanicLatino> element.
LanguageList	getLanguageList() Gets the value of the <LanguageList> element.
java.lang.String	getMaritalStatus() Gets the value of the <MaritalStatus> element.
java.lang.String	getPlaceOfBirth() Gets the value of the <PlaceOfBirth> element.
RaceList	getRaceList() Gets the value of the <RaceList> element.
java.lang.String	getStateOfBirth() Gets the value of the <StateOfBirth> element.
void	removeCountriesOfCitizenship() Removes the CountriesOfCitizenship child element previously created by calling setCountriesOfCitizenship
void	removeCountriesOfResidency() Removes the CountriesOfResidency child element previously created by calling setCountriesOfResidency
void	removeDwellingArrangement() Removes the DwellingArrangement child element previously created by calling setDwellingArrangement
void	removeEnglishProficiency() Removes the EnglishProficiency child element previously created by calling setEnglishProficiency
void	removeLanguageList() Removes the LanguageList child element previously created by calling setLanguageList
void	removeRaceList() Removes the RaceList child element previously created by calling setRaceList
void	setBirthDate(java.util.Calendar value) Sets the value of the <BirthDate> element.
void	setBirthDateVerification(BirthDateVerification value) Sets the value of the <BirthDateVerification> element.
void	setBirthDateVerification(java.lang.String value) Sets the value of the <BirthDateVerification> element as a String.
void	setCitizenshipStatus(CitizenshipStatus value) Sets the value of the <CitizenshipStatus> element.
void	setCitizenshipStatus(java.lang.String value) Sets the value of the <CitizenshipStatus> element as a String.
void	setCountriesOfCitizenship(CountriesOfCitizenship value) Sets the value of the <CountriesOfCitizenship> element.
void	setCountriesOfResidency(CountriesOfResidency value) Sets the value of the <CountriesOfResidency> element.
void	setCountryArrivalDate(java.util.Calendar value) Sets the value of the <CountryArrivalDate> element.
void	setCountryOfBirth(CountryCode value) Sets the value of the <CountryOfBirth> element.
void	setCountryOfBirth(java.lang.String value) Sets the value of the <CountryOfBirth> element as a String.
void	setCountyOfBirth(java.lang.String value) Sets the value of the <CountyOfBirth> element.
void	setDwellingArrangement(DwellingArrangement value) Sets the value of the <DwellingArrangement> element.
void	setEnglishProficiency(EnglishProficiency value) Sets the value of the <EnglishProficiency> element.
void	setEnglishProficiency(EnglishProficiencyCode code) Sets the value of the <EnglishProficiency> child element.
void	setGender(Gender value) Sets the value of the <Gender> element.
void	setGender(java.lang.String value) Sets the value of the <Gender> element as a String.
void	setHispanicLatino(java.lang.String value) Sets the value of the <HispanicLatino> element as a String.
void	setHispanicLatino(YesNo value) Sets the value of the <HispanicLatino> element.
void	setLanguageList(LanguageList value) Sets the value of the <LanguageList> element.
void	setMaritalStatus(MaritalStatus value) Sets the value of the <MaritalStatus> element.
void	setMaritalStatus(java.lang.String value) Sets the value of the <MaritalStatus> element as a String.
void	setPlaceOfBirth(java.lang.String value) Sets the value of the <PlaceOfBirth> element.
void	setRaceList(RaceList value) Sets the value of the <RaceList> element.
void	setStateOfBirth(StatePrCode value) Sets the value of the <StateOfBirth> element.
void	setStateOfBirth(java.lang.String value) Sets the value of the <StateOfBirth> element 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, getKey, 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

Demographics

public Demographics()

Constructor

Method Detail

setRaceList

public void setRaceList(RaceList value)

Sets the value of the <RaceList> element.

The SIF specification defines the meaning of this element as: "The person's race or ethnicity"

Parameters:

value - A RaceList object

Since:

1.1

getRaceList

public RaceList getRaceList()

Gets the value of the <RaceList> element.

The SIF specification defines the meaning of this element as: "The person's race or ethnicity"

Returns:

A RaceList object

Since:

1.1

removeRaceList

public void removeRaceList()

Removes the RaceList child element previously created by calling setRaceList

Since:

1.1

getHispanicLatino

public java.lang.String getHispanicLatino()

Gets the value of the <HispanicLatino> element.

Returns:

The HispanicLatino element of this object.

Since:

2.0

setHispanicLatino

public void setHispanicLatino(YesNo value)

Sets the value of the <HispanicLatino> element.

Parameters:

value - A constant defined by the YesNo class

Since:

2.0

setHispanicLatino

public void setHispanicLatino(java.lang.String value)

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

Parameters:

value - The value as a String

Since:

2.0

getGender

public java.lang.String getGender()

Gets the value of the <Gender> element.

The SIF specification defines the meaning of this element as: "Person's gender."

Returns:

The Gender element of this object.

Since:

1.1

setGender

public void setGender(Gender value)

Sets the value of the <Gender> element.

The SIF specification defines the meaning of this element as: "Person's gender."

Parameters:

value - A constant defined by the Gender class

Since:

1.1

setGender

public void setGender(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Person's gender."

Parameters:

value - The value as a String

Since:

1.1

getBirthDate

public java.util.Calendar getBirthDate()

Gets the value of the <BirthDate> element.

The SIF specification defines the meaning of this element as: "The person's date of birth."

Returns:

The BirthDate element of this object.

Since:

1.1

setBirthDate

public void setBirthDate(java.util.Calendar value)

Sets the value of the <BirthDate> element.

The SIF specification defines the meaning of this element as: "The person's date of birth."

Parameters:

value - A Calendar object

Since:

1.1

getBirthDateVerification

public java.lang.String getBirthDateVerification()

Gets the value of the <BirthDateVerification> element.

The SIF specification defines the meaning of this element as: "Means by which the person's birth date was validated."

Returns:

The BirthDateVerification element of this object.

Since:

1.1

setBirthDateVerification

public void setBirthDateVerification(BirthDateVerification value)

Sets the value of the <BirthDateVerification> element.

The SIF specification defines the meaning of this element as: "Means by which the person's birth date was validated."

Parameters:

value - A constant defined by the BirthDateVerification class

Since:

1.1

setBirthDateVerification

public void setBirthDateVerification(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Means by which the person's birth date was validated."

Parameters:

value - The value as a String

Since:

1.1

getPlaceOfBirth

public java.lang.String getPlaceOfBirth()

Gets the value of the <PlaceOfBirth> element.

The SIF specification defines the meaning of this element as: "The person's place of birth--like village, town, city etc."

Returns:

The PlaceOfBirth element of this object.

Since:

1.1

setPlaceOfBirth

public void setPlaceOfBirth(java.lang.String value)

Sets the value of the <PlaceOfBirth> element.

The SIF specification defines the meaning of this element as: "The person's place of birth--like village, town, city etc."

Parameters:

value - A String object

Since:

1.1

getCountyOfBirth

public java.lang.String getCountyOfBirth()

Gets the value of the <CountyOfBirth> element.

The SIF specification defines the meaning of this element as: "The county in which the person was born."

Returns:

The CountyOfBirth element of this object.

Since:

1.1

setCountyOfBirth

public void setCountyOfBirth(java.lang.String value)

Sets the value of the <CountyOfBirth> element.

The SIF specification defines the meaning of this element as: "The county in which the person was born."

Parameters:

value - A String object

Since:

1.1

getStateOfBirth

public java.lang.String getStateOfBirth()

Gets the value of the <StateOfBirth> element.

The SIF specification defines the meaning of this element as: "The person's state of birth."

Returns:

The StateOfBirth element of this object.

Since:

1.1

setStateOfBirth

public void setStateOfBirth(StatePrCode value)

Sets the value of the <StateOfBirth> element.

The SIF specification defines the meaning of this element as: "The person's state of birth."

Parameters:

value - A constant defined by the StatePrCode class

Since:

1.1

setStateOfBirth

public void setStateOfBirth(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "The person's state of birth."

Parameters:

value - The value as a String

Since:

1.1

getCountryOfBirth

public java.lang.String getCountryOfBirth()

Gets the value of the <CountryOfBirth> element.

The SIF specification defines the meaning of this element as: "The person's country of birth."

Returns:

The CountryOfBirth element of this object.

Since:

1.1

setCountryOfBirth

public void setCountryOfBirth(CountryCode value)

Sets the value of the <CountryOfBirth> element.

The SIF specification defines the meaning of this element as: "The person's country of birth."

Parameters:

value - A constant defined by the CountryCode class

Since:

1.1

setCountryOfBirth

public void setCountryOfBirth(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "The person's country of birth."

Parameters:

value - The value as a String

Since:

1.1

setCountriesOfCitizenship

public void setCountriesOfCitizenship(CountriesOfCitizenship value)

Sets the value of the <CountriesOfCitizenship> element.

The SIF specification defines the meaning of this element as: "The person's country of citizenship"

Parameters:

value - A CountriesOfCitizenship object

Since:

1.1

getCountriesOfCitizenship

public CountriesOfCitizenship getCountriesOfCitizenship()

Gets the value of the <CountriesOfCitizenship> element.

The SIF specification defines the meaning of this element as: "The person's country of citizenship"

Returns:

A CountriesOfCitizenship object

Since:

1.1

removeCountriesOfCitizenship

public void removeCountriesOfCitizenship()

Removes the CountriesOfCitizenship child element previously created by calling setCountriesOfCitizenship

Since:

1.1

setCountriesOfResidency

public void setCountriesOfResidency(CountriesOfResidency value)

Sets the value of the <CountriesOfResidency> element.

The SIF specification defines the meaning of this element as: "The person's country of residence"

Parameters:

value - A CountriesOfResidency object

Since:

1.1

getCountriesOfResidency

public CountriesOfResidency getCountriesOfResidency()

Gets the value of the <CountriesOfResidency> element.

The SIF specification defines the meaning of this element as: "The person's country of residence"

Returns:

A CountriesOfResidency object

Since:

1.1

removeCountriesOfResidency

public void removeCountriesOfResidency()

Removes the CountriesOfResidency child element previously created by calling setCountriesOfResidency

Since:

1.1

getCountryArrivalDate

public java.util.Calendar getCountryArrivalDate()

Gets the value of the <CountryArrivalDate> element.

The SIF specification defines the meaning of this element as: "Date the person first arrived in the country."

Returns:

The CountryArrivalDate element of this object.

Since:

1.5r1

setCountryArrivalDate

public void setCountryArrivalDate(java.util.Calendar value)

Sets the value of the <CountryArrivalDate> element.

The SIF specification defines the meaning of this element as: "Date the person first arrived in the country."

Parameters:

value - A Calendar object

Since:

1.5r1

getCitizenshipStatus

public java.lang.String getCitizenshipStatus()

Gets the value of the <CitizenshipStatus> element.

The SIF specification defines the meaning of this element as: "The person's citizenship status."

Returns:

The CitizenshipStatus element of this object.

Since:

1.1

setCitizenshipStatus

public void setCitizenshipStatus(CitizenshipStatus value)

Sets the value of the <CitizenshipStatus> element.

The SIF specification defines the meaning of this element as: "The person's citizenship status."

Parameters:

value - A constant defined by the CitizenshipStatus class

Since:

1.1

setCitizenshipStatus

public void setCitizenshipStatus(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "The person's citizenship status."

Parameters:

value - The value as a String

Since:

1.1

setEnglishProficiency

public void setEnglishProficiency(EnglishProficiency value)

Sets the value of the <EnglishProficiency> element.

The SIF specification defines the meaning of this element as: "The person's proficiency in English"

Parameters:

value - A EnglishProficiency object

Since:

1.1

setEnglishProficiency

public void setEnglishProficiency(EnglishProficiencyCode code)

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

Parameters:

code - Person's proficiency in English.

Since:

1.1

getEnglishProficiency

public EnglishProficiency getEnglishProficiency()

Gets the value of the <EnglishProficiency> element.

The SIF specification defines the meaning of this element as: "The person's proficiency in English"

Returns:

An EnglishProficiency object

Since:

1.1

removeEnglishProficiency

public void removeEnglishProficiency()

Removes the EnglishProficiency child element previously created by calling setEnglishProficiency

Since:

1.1

setLanguageList

public void setLanguageList(LanguageList value)

Sets the value of the <LanguageList> element.

The SIF specification defines the meaning of this element as: "The code that specifies the person's language"

Parameters:

value - A LanguageList object

Since:

1.1

getLanguageList

public LanguageList getLanguageList()

Gets the value of the <LanguageList> element.

The SIF specification defines the meaning of this element as: "The code that specifies the person's language"

Returns:

A LanguageList object

Since:

1.1

removeLanguageList

public void removeLanguageList()

Removes the LanguageList child element previously created by calling setLanguageList

Since:

1.1

setDwellingArrangement

public void setDwellingArrangement(DwellingArrangement value)

Sets the value of the <DwellingArrangement> element.

The SIF specification defines the meaning of this element as: "Setting/environment in which the persion resides"

Parameters:

value - A DwellingArrangement object

Since:

1.1

getDwellingArrangement

public DwellingArrangement getDwellingArrangement()

Gets the value of the <DwellingArrangement> element.

The SIF specification defines the meaning of this element as: "Setting/environment in which the persion resides"

Returns:

A DwellingArrangement object

Since:

1.1

removeDwellingArrangement

public void removeDwellingArrangement()

Removes the DwellingArrangement child element previously created by calling setDwellingArrangement

Since:

1.1

getMaritalStatus

public java.lang.String getMaritalStatus()

Gets the value of the <MaritalStatus> element.

The SIF specification defines the meaning of this element as: "The person's marital status."

Returns:

The MaritalStatus element of this object.

Since:

1.1

setMaritalStatus

public void setMaritalStatus(MaritalStatus value)

Sets the value of the <MaritalStatus> element.

The SIF specification defines the meaning of this element as: "The person's marital status."

Parameters:

value - A constant defined by the MaritalStatus class

Since:

1.1

setMaritalStatus

public void setMaritalStatus(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "The person's marital status."

Parameters:

value - The value as a String

Since:

1.1