com.edustructures.sifworks.profdev
Class EmployeeCredential

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.profdev.EmployeeCredential

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class EmployeeCredential
extends SIFDataObject

This object contains HR, certification and teaching assignment information for elementary and secondary professional personnel for state reporting. It is a snapshot object used for vertical reporting of data related to K-12 elementary and secondary professional employees. SIF_Events are not 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

EmployeeCredential()
Constructor

EmployeeCredential(java.util.Calendar reportDate, java.lang.Integer schoolYear, java.lang.String stateProvinceId, java.lang.String ssn, Name name, RaceType race, Certifications certifications, java.math.BigDecimal salary, EmploymentStatus status, YesNo leave, java.math.BigDecimal totalYears, java.math.BigDecimal unitYears, TeachingCredentialBasis education)
Constructor that accepts values for all mandatory fields

Method Summary

void	addTeachingCredentialType(TeachingCredential value) Adds a new <TeachingCredentialType> child element.
void	addTeachingCredentialType(TeachingCredentialType value) Adds a new <TeachingCredentialType> repeatable element.
EmployeeAssignments	getAssignments() Gets the value of the <Assignments> element.
BackgroundChecks	getBackgroundChecks() Gets the value of the <BackgroundChecks> element.
Certifications	getCertifications() Gets the value of the <Certifications> element.
Demographics	getDemographics() Gets the value of the <Demographics> element.
java.lang.String	getEducation() Gets the value of the <Education> element.
java.lang.String	getHispanic() Gets the value of the <Hispanic> 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	getLeave() Gets the value of the <Leave> element.
Name	getName() Gets the value of the <Name> element.
java.lang.String	getRace() Gets the value of the <Race> element.
java.util.Calendar	getReportDate() Gets the value of the <ReportDate> element.
java.math.BigDecimal	getSalary() Gets the value of the <Salary> element.
java.lang.Integer	getSchoolYear() Gets the value of the <SchoolYear> element.
java.lang.String	getSSN() Gets the value of the <SSN> element.
java.lang.String	getStateProvinceId() Gets the value of the <StateProvinceId> element.
java.lang.String	getStatus() Gets the value of the <Status> element.
TeachingCredential	getTeachingCredentialType(TeachingCredentialType value) Gets a TeachingCredential object instance.
TeachingCredential[]	getTeachingCredentialTypes() Gets all TeachingCredential object instances.
java.lang.String	getTerminationCode() Gets the value of the <TerminationCode> element.
java.math.BigDecimal	getTotalYears() Gets the value of the <TotalYears> element.
java.math.BigDecimal	getUnitYears() Gets the value of the <UnitYears> element.
void	removeAssignments() Removes the Assignments child element previously created by calling setAssignments
void	removeBackgroundChecks() Removes the BackgroundChecks child element previously created by calling setBackgroundChecks
void	removeCertifications() Removes the Certifications child element previously created by calling setCertifications
void	removeDemographics() Removes the Demographics child element previously created by calling setDemographics
void	removeName() Removes the Name child element previously created by calling setName
void	removeTeachingCredentialType(TeachingCredentialType value) Removes a TeachingCredential object instance.
void	setAssignments(EmployeeAssignments value) Sets the value of the <Assignments> element.
void	setBackgroundChecks(BackgroundChecks value) Sets the value of the <BackgroundChecks> element.
void	setCertifications(Certifications value) Sets the value of the <Certifications> element.
void	setDemographics(Demographics value) Sets the value of the <Demographics> element.
void	setEducation(java.lang.String value) Sets the value of the <Education> element as a String.
void	setEducation(TeachingCredentialBasis value) Sets the value of the <Education> element.
void	setHispanic(java.lang.String value) Sets the value of the <Hispanic> element as a String.
void	setHispanic(YesNo value) Sets the value of the <Hispanic> element.
void	setLeave(java.lang.String value) Sets the value of the <Leave> element as a String.
void	setLeave(YesNo value) Sets the value of the <Leave> element.
void	setName(Name value) Sets the value of the <Name> element.
void	setName(NameType type, java.lang.String lastName, java.lang.String firstName) Sets the value of the <Name> child element.
void	setRace(RaceType value) Sets the value of the <Race> element.
void	setRace(java.lang.String value) Sets the value of the <Race> element as a String.
void	setReportDate(java.util.Calendar value) Sets the value of the <ReportDate> element.
void	setSalary(java.math.BigDecimal value) Sets the value of the <Salary> element.
void	setSchoolYear(java.lang.Integer value) Sets the value of the <SchoolYear> element.
void	setSSN(java.lang.String value) Sets the value of the <SSN> element.
void	setStateProvinceId(java.lang.String value) Sets the value of the <StateProvinceId> element.
void	setStatus(EmploymentStatus value) Sets the value of the <Status> element.
void	setStatus(java.lang.String value) Sets the value of the <Status> element as a String.
void	setTeachingCredentialTypes(TeachingCredential[] teachingcredentialtypes) Sets an array of TeachingCredential objects.
void	setTerminationCode(EmploymentSeperationReason value) Sets the value of the <TerminationCode> element.
void	setTerminationCode(java.lang.String value) Sets the value of the <TerminationCode> element as a String.
void	setTotalYears(java.math.BigDecimal value) Sets the value of the <TotalYears> element.
void	setUnitYears(java.math.BigDecimal value) Sets the value of the <UnitYears> element.

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

EmployeeCredential

public EmployeeCredential()

Constructor

EmployeeCredential

public EmployeeCredential(java.util.Calendar reportDate,
                          java.lang.Integer schoolYear,
                          java.lang.String stateProvinceId,
                          java.lang.String ssn,
                          Name name,
                          RaceType race,
                          Certifications certifications,
                          java.math.BigDecimal salary,
                          EmploymentStatus status,
                          YesNo leave,
                          java.math.BigDecimal totalYears,
                          java.math.BigDecimal unitYears,
                          TeachingCredentialBasis education)

Constructor that accepts values for all mandatory fields

Parameters:

reportDate - Date that report snapshot was generated

schoolYear - School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2004" for the 2003-04 school year).

stateProvinceId - State assigned reporting unit number

ssn - Employee social security number

name - Name of employee.

race - Primary employee's race

certifications - Employee certification area information

salary - Employee's salary

status -

leave - Is this employee on leave this year?

totalYears - Total number of years employee has been in a professional position

unitYears - Total number of years at current LEA

education - Highest level of education attained by employee.

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

getReportDate

public java.util.Calendar getReportDate()

Gets the value of the <ReportDate> element.

The SIF specification defines the meaning of this element as: "Date that report snapshot was generated"

Returns:

The ReportDate element of this object.

Since:

1.5r1

setReportDate

public void setReportDate(java.util.Calendar value)

Sets the value of the <ReportDate> element.

The SIF specification defines the meaning of this element as: "Date that report snapshot was generated"

Parameters:

value - A Calendar object

Since:

1.5r1

getSchoolYear

public java.lang.Integer getSchoolYear()

Gets the value of the <SchoolYear> element.

The SIF specification defines the meaning of this element as: "School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2004" for the 2003-04 school year)."

Returns:

The SchoolYear element of this object.

Since:

1.5r1

setSchoolYear

public void setSchoolYear(java.lang.Integer value)

Sets the value of the <SchoolYear> element.

The SIF specification defines the meaning of this element as: "School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2004" for the 2003-04 school year)."

Parameters:

value - A Integer 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: "State assigned reporting unit number"

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(java.lang.String value)

Sets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "State assigned reporting unit number"

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 String object

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: "Employee social security number"

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: "Employee social security number"

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

setName

public void setName(Name value)

Sets the value of the <Name> element.

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

Parameters:

value - A Name object

Since:

1.5r1

setName

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

Sets the value of the <Name> child 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

getName

public Name getName()

Gets the value of the <Name> element.

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

Returns:

A Name object

Since:

1.5r1

removeName

public void removeName()

Removes the Name child element previously created by calling setName

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: "This element contains information related to employee demographics."

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: "This element contains information related to employee demographics."

Returns:

A Demographics object

Since:

1.5r1

removeDemographics

public void removeDemographics()

Removes the Demographics child element previously created by calling setDemographics

Since:

1.5r1

getRace

public java.lang.String getRace()

Gets the value of the <Race> element.

The SIF specification defines the meaning of this element as: "Primary employee's race"

Returns:

The Race element of this object.

Since:

1.5r1

setRace

public void setRace(RaceType value)

Sets the value of the <Race> element.

The SIF specification defines the meaning of this element as: "Primary employee's race"

Parameters:

value - A constant defined by the RaceType class

Since:

1.5r1

setRace

public void setRace(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Primary employee's race"

Parameters:

value - The value as a String

Since:

1.5r1

getHispanic

public java.lang.String getHispanic()

Gets the value of the <Hispanic> element.

The SIF specification defines the meaning of this element as: "Is this employee Hispanic or Latino?"

Returns:

The Hispanic element of this object.

Since:

1.5r1

setHispanic

public void setHispanic(YesNo value)

Sets the value of the <Hispanic> element.

The SIF specification defines the meaning of this element as: "Is this employee Hispanic or Latino?"

Parameters:

value - A constant defined by the YesNo class

Since:

1.5r1

setHispanic

public void setHispanic(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Is this employee Hispanic or Latino?"

Parameters:

value - The value as a String

Since:

1.5r1

setCertifications

public void setCertifications(Certifications value)

Sets the value of the <Certifications> element.

The SIF specification defines the meaning of this element as: "Employee certification area information"

Parameters:

value - A Certifications object

Since:

1.5r1

getCertifications

public Certifications getCertifications()

Gets the value of the <Certifications> element.

The SIF specification defines the meaning of this element as: "Employee certification area information"

Returns:

A Certifications object

Since:

1.5r1

removeCertifications

public void removeCertifications()

Removes the Certifications child element previously created by calling setCertifications

Since:

1.5r1

getSalary

public java.math.BigDecimal getSalary()

Gets the value of the <Salary> element.

The SIF specification defines the meaning of this element as: "Employee's salary"

Returns:

The Salary element of this object.

Since:

1.5r1

setSalary

public void setSalary(java.math.BigDecimal value)

Sets the value of the <Salary> element.

The SIF specification defines the meaning of this element as: "Employee's salary"

Parameters:

value - A BigDecimal object

Since:

1.5r1

getStatus

public java.lang.String getStatus()

Gets the value of the <Status> element.

Returns:

The Status element of this object.

Since:

1.5r1

setStatus

public void setStatus(EmploymentStatus value)

Sets the value of the <Status> element.

Parameters:

value - A constant defined by the EmploymentStatus class

Since:

1.5r1

setStatus

public void setStatus(java.lang.String value)

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

Parameters:

value - The value as a String

Since:

1.5r1

getLeave

public java.lang.String getLeave()

Gets the value of the <Leave> element.

The SIF specification defines the meaning of this element as: "Is this employee on leave this year?"

Returns:

The Leave element of this object.

Since:

1.5r1

setLeave

public void setLeave(YesNo value)

Sets the value of the <Leave> element.

The SIF specification defines the meaning of this element as: "Is this employee on leave this year?"

Parameters:

value - A constant defined by the YesNo class

Since:

1.5r1

setLeave

public void setLeave(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Is this employee on leave this year?"

Parameters:

value - The value as a String

Since:

1.5r1

getTotalYears

public java.math.BigDecimal getTotalYears()

Gets the value of the <TotalYears> element.

The SIF specification defines the meaning of this element as: "Total number of years employee has been in a professional position"

Returns:

The TotalYears element of this object.

Since:

1.5r1

setTotalYears

public void setTotalYears(java.math.BigDecimal value)

Sets the value of the <TotalYears> element.

The SIF specification defines the meaning of this element as: "Total number of years employee has been in a professional position"

Parameters:

value - A BigDecimal object

Since:

1.5r1

getUnitYears

public java.math.BigDecimal getUnitYears()

Gets the value of the <UnitYears> element.

The SIF specification defines the meaning of this element as: "Total number of years at current LEA"

Returns:

The UnitYears element of this object.

Since:

1.5r1

setUnitYears

public void setUnitYears(java.math.BigDecimal value)

Sets the value of the <UnitYears> element.

The SIF specification defines the meaning of this element as: "Total number of years at current LEA"

Parameters:

value - A BigDecimal object

Since:

1.5r1

getEducation

public java.lang.String getEducation()

Gets the value of the <Education> element.

The SIF specification defines the meaning of this element as: "Highest level of education attained by employee."

Returns:

The Education element of this object.

Since:

1.5r1

setEducation

public void setEducation(TeachingCredentialBasis value)

Sets the value of the <Education> element.

The SIF specification defines the meaning of this element as: "Highest level of education attained by employee."

Parameters:

value - A constant defined by the TeachingCredentialBasis class

Since:

1.5r1

setEducation

public void setEducation(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Highest level of education attained by employee."

Parameters:

value - The value as a String

Since:

1.5r1

addTeachingCredentialType

public void addTeachingCredentialType(TeachingCredential value)

Adds a new <TeachingCredentialType> child element.

The SIF specification defines the meaning of this element as: "Category in which teacher is authorized to teach"

Parameters:

value - A TeachingCredential object

Since:

1.5r1

addTeachingCredentialType

public void addTeachingCredentialType(TeachingCredentialType value)

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

Parameters:

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

Since:

1.5r1

removeTeachingCredentialType

public void removeTeachingCredentialType(TeachingCredentialType value)

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

Parameters:

value - Identifies the TeachingCredential object to remove by its Value value

Since:

1.5r1

getTeachingCredentialType

public TeachingCredential getTeachingCredentialType(TeachingCredentialType value)

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

Parameters:

value - Identifies the TeachingCredential object to return by its "Value" attribute value

Returns:

A TeachingCredential object

Since:

1.5r1

getTeachingCredentialTypes

public TeachingCredential[] getTeachingCredentialTypes()

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

Returns:

An array of TeachingCredential objects

Since:

1.5r1

setTeachingCredentialTypes

public void setTeachingCredentialTypes(TeachingCredential[] teachingcredentialtypes)

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

Since:

1.5r1

getTerminationCode

public java.lang.String getTerminationCode()

Gets the value of the <TerminationCode> element.

The SIF specification defines the meaning of this element as: "If appropriate, employment separation reason"

Returns:

The TerminationCode element of this object.

Since:

1.5r1

setTerminationCode

public void setTerminationCode(EmploymentSeperationReason value)

Sets the value of the <TerminationCode> element.

The SIF specification defines the meaning of this element as: "If appropriate, employment separation reason"

Parameters:

value - A constant defined by the EmploymentSeperationReason class

Since:

1.5r1

setTerminationCode

public void setTerminationCode(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "If appropriate, employment separation reason"

Parameters:

value - The value as a String

Since:

1.5r1

setBackgroundChecks

public void setBackgroundChecks(BackgroundChecks value)

Sets the value of the <BackgroundChecks> element.

The SIF specification defines the meaning of this element as: "Information about background checks done on employee"

Parameters:

value - A BackgroundChecks object

Since:

1.5r1

getBackgroundChecks

public BackgroundChecks getBackgroundChecks()

Gets the value of the <BackgroundChecks> element.

The SIF specification defines the meaning of this element as: "Information about background checks done on employee"

Returns:

A BackgroundChecks object

Since:

1.5r1

removeBackgroundChecks

public void removeBackgroundChecks()

Removes the BackgroundChecks child element previously created by calling setBackgroundChecks

Since:

1.5r1

setAssignments

public void setAssignments(EmployeeAssignments value)

Sets the value of the <Assignments> element.

The SIF specification defines the meaning of this element as: "Information about the school and assignment of employee"

Parameters:

value - A EmployeeAssignments object

Since:

1.5r1

getAssignments

public EmployeeAssignments getAssignments()

Gets the value of the <Assignments> element.

The SIF specification defines the meaning of this element as: "Information about the school and assignment of employee"

Returns:

An EmployeeAssignments object

Since:

1.5r1

removeAssignments

public void removeAssignments()

Removes the Assignments child element previously created by calling setAssignments

Since:

1.5r1