com.edustructures.sifworks.hrfin
Class EmployeePersonal

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class EmployeePersonal
extends SIFDataObject

This object contains basic HR information for employees. 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

EmployeePersonal()
Constructor

EmployeePersonal(java.lang.String refId, Name name, java.lang.String ssn)
Constructor that accepts values for all mandatory fields

Method Summary

AddressList	getAddressList() Gets the value of the <AddressList> element.
Demographics	getDemographics() Gets the value of the <Demographics> element.
EmailList	getEmailList() Gets the value of the <EmailList> 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
Name	getName() Gets the value of the <Name> element.
HrOtherIdList	getOtherIdList() Gets the value of the <OtherIdList> element.
PhoneNumberList	getPhoneNumberList() Gets the value of the <PhoneNumberList> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSsn() Gets the value of the <Ssn> 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	removeDemographics() Removes the Demographics child element previously created by calling setDemographics
void	removeEmailList() Removes the EmailList child element previously created by calling setEmailList
void	removeName() Removes the Name child element previously created by calling setName
void	removeOtherIdList() Removes the OtherIdList child element previously created by calling setOtherIdList
void	removePhoneNumberList() Removes the PhoneNumberList child element previously created by calling setPhoneNumberList
void	setAddressList(AddressList value) Sets the value of the <AddressList> element.
void	setDemographics(Demographics value) Sets the value of the <Demographics> element.
void	setEmailList(EmailList value) Sets the value of the <EmailList> 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	setOtherIdList(HrOtherIdList value) Sets the value of the <OtherIdList> 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	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.

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

EmployeePersonal

public EmployeePersonal()

Constructor

EmployeePersonal

public EmployeePersonal(java.lang.String refId,
                        Name name,
                        java.lang.String ssn)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The GUID that uniquely identifies this employee.

name - Name of employee.

ssn - Social security number of 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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID that uniquely identifies this employee."

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 GUID that uniquely identifies this employee."

Parameters:

value - A String object

Since:

1.5r1

setOtherIdList

public void setOtherIdList(HrOtherIdList value)

Sets the value of the <OtherIdList> element.

The SIF specification defines the meaning of this element as: "This field can hold SSN, state and locally assigned IDs."

Parameters:

value - A HrOtherIdList object

Since:

1.5r1

getOtherIdList

public HrOtherIdList getOtherIdList()

Gets the value of the <OtherIdList> element.

The SIF specification defines the meaning of this element as: "This field can hold SSN, state and locally assigned IDs."

Returns:

An HrOtherIdList object

Since:

1.5r1

removeOtherIdList

public void removeOtherIdList()

Removes the OtherIdList child element previously created by calling setOtherIdList

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 staff member."

Returns:

The StateProvinceId element of this object.

Since:

2.0

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: "The state-assigned identifier for this staff member."

Parameters:

value - A String object

Since:

2.0

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

setEmailList

public void setEmailList(EmailList value)

Sets the value of the <EmailList> element.

The SIF specification defines the meaning of this element as: "The employee's e-mail address(es)."

Parameters:

value - A EmailList object

Since:

1.5r1

getEmailList

public EmailList getEmailList()

Gets the value of the <EmailList> element.

The SIF specification defines the meaning of this element as: "The employee's e-mail address(es)."

Returns:

An EmailList object

Since:

1.5r1

removeEmailList

public void removeEmailList()

Removes the EmailList child element previously created by calling setEmailList

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

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

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

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: "The employee's address(es)."

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: "The employee's address(es)."

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 employee's phone number(s)."

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 employee's phone number(s)."

Returns:

A PhoneNumberList object

Since:

1.5r1

removePhoneNumberList

public void removePhoneNumberList()

Removes the PhoneNumberList child element previously created by calling setPhoneNumberList

Since:

1.5r1