com.edustructures.sifworks.hrfin
Class EmployeeAssignment

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class EmployeeAssignment
extends SIFDataObject

This object defines information related to a staff member's assignment as it pertains to the human resource needed to track staff assignment for staff reporting and financial funding tracking. 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

EmployeeAssignment()
Constructor

EmployeeAssignment(java.lang.String refId, java.lang.String employeePersonalRefId, java.lang.String description, YesNo primaryAssignment)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the <Description> element.
java.lang.String	getEmployeePersonalRefId() Gets the value of the EmployeePersonalRefId attribute.
ProgramFundingSource	getFundingSource() Gets the value of the <FundingSource> element.
JobClassification	getJobClassification() Gets the value of the <JobClassification> element.
java.util.Calendar	getJobEndDate() Gets the value of the <JobEndDate> element.
java.math.BigDecimal	getJobFTE() Gets the value of the <JobFTE> element.
java.util.Calendar	getJobStartDate() Gets the value of the <JobStartDate> 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	getLocationInfoRefId() Gets the value of the <LocationInfoRefId> element.
java.lang.String	getPrimaryAssignment() Gets the value of the <PrimaryAssignment> element.
HRProgramType	getProgramType() Gets the value of the <ProgramType> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
StaffLink	getSISId() Gets the value of the <SISId> element.
void	removeFundingSource() Removes the FundingSource child element previously created by calling setFundingSource
void	removeJobClassification() Removes the JobClassification child element previously created by calling setJobClassification
void	removeProgramType() Removes the ProgramType child element previously created by calling setProgramType
void	removeSISId() Removes the SISId child element previously created by calling setSISId
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setEmployeePersonalRefId(java.lang.String value) Sets the value of the EmployeePersonalRefId attribute.
void	setFundingSource(ProgramFundingSource value) Sets the value of the <FundingSource> element.
void	setJobClassification(JobClassification value) Sets the value of the <JobClassification> element.
void	setJobClassification(JobClassificationCode code) Sets the value of the <JobClassification> child element.
void	setJobEndDate(java.util.Calendar value) Sets the value of the <JobEndDate> element.
void	setJobFTE(java.math.BigDecimal value) Sets the value of the <JobFTE> element.
void	setJobStartDate(java.util.Calendar value) Sets the value of the <JobStartDate> element.
void	setLocationInfoRefId(java.lang.String value) Sets the value of the <LocationInfoRefId> element.
void	setPrimaryAssignment(java.lang.String value) Sets the value of the <PrimaryAssignment> element as a String.
void	setPrimaryAssignment(YesNo value) Sets the value of the <PrimaryAssignment> element.
void	setProgramType(HRProgramType value) Sets the value of the <ProgramType> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSISId(StaffLink value) Sets the value of the <SISId> element.
void	setSISId(java.lang.String staffPersonalRefId) Sets the value of the <SISId> child 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

EmployeeAssignment

public EmployeeAssignment()

Constructor

EmployeeAssignment

public EmployeeAssignment(java.lang.String refId,
                          java.lang.String employeePersonalRefId,
                          java.lang.String description,
                          YesNo primaryAssignment)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The GUID that uniquely identifies a particular HR staff assignment.

employeePersonalRefId - This GUID referencing the parent EmployeePersonal object

description - Short assignment description

primaryAssignment - Is this the staff member's primary assignment? There must be one and only one instance of the object with Yes in this value per school year.

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 a particular HR staff assignment."

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 a particular HR staff assignment."

Parameters:

value - A String object

Since:

1.5r1

getEmployeePersonalRefId

public java.lang.String getEmployeePersonalRefId()

Gets the value of the EmployeePersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "This GUID referencing the parent EmployeePersonal object"

Returns:

The EmployeePersonalRefId attribute of this object.

Since:

1.5r1

setEmployeePersonalRefId

public void setEmployeePersonalRefId(java.lang.String value)

Sets the value of the EmployeePersonalRefId attribute.

The SIF specification defines the meaning of this attribute as: "This GUID referencing the parent EmployeePersonal object"

Parameters:

value - A String object

Since:

1.5r1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Short assignment description"

Returns:

The Description element of this object.

Since:

1.5r1

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Short assignment description"

Parameters:

value - A String object

Since:

1.5r1

getLocationInfoRefId

public java.lang.String getLocationInfoRefId()

Gets the value of the <LocationInfoRefId> element.

The SIF specification defines the meaning of this element as: " This is an optional element so the placement of the employee within the agency can be tracked as needed. The GUID references the LocationInfo object. "

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	"LocationId"
SIF2.0	"LocationInfoRefId"

Returns:

The LocationInfoRefId element of this object.

Since:

1.5r1

setLocationInfoRefId

public void setLocationInfoRefId(java.lang.String value)

Sets the value of the <LocationInfoRefId> element.

The SIF specification defines the meaning of this element as: " This is an optional element so the placement of the employee within the agency can be tracked as needed. The GUID references the LocationInfo object. "

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	"LocationId"
SIF2.0	"LocationInfoRefId"

Parameters:

value - A String object

Since:

1.5r1

getPrimaryAssignment

public java.lang.String getPrimaryAssignment()

Gets the value of the <PrimaryAssignment> element.

The SIF specification defines the meaning of this element as: "Is this the staff member's primary assignment? There must be one and only one instance of the object with Yes in this value per school year."

Returns:

The PrimaryAssignment element of this object.

Since:

2.0

setPrimaryAssignment

public void setPrimaryAssignment(YesNo value)

Sets the value of the <PrimaryAssignment> element.

The SIF specification defines the meaning of this element as: "Is this the staff member's primary assignment? There must be one and only one instance of the object with Yes in this value per school year."

Parameters:

value - A constant defined by the YesNo class

Since:

2.0

setPrimaryAssignment

public void setPrimaryAssignment(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Is this the staff member's primary assignment? There must be one and only one instance of the object with Yes in this value per school year."

Parameters:

value - The value as a String

Since:

2.0

getJobStartDate

public java.util.Calendar getJobStartDate()

Gets the value of the <JobStartDate> element.

The SIF specification defines the meaning of this element as: "This is the date from which the staff assignment is valid (inclusive)."

Returns:

The JobStartDate element of this object.

Since:

1.5r1

setJobStartDate

public void setJobStartDate(java.util.Calendar value)

Sets the value of the <JobStartDate> element.

The SIF specification defines the meaning of this element as: "This is the date from which the staff assignment is valid (inclusive)."

Parameters:

value - A Calendar object

Since:

1.5r1

getJobEndDate

public java.util.Calendar getJobEndDate()

Gets the value of the <JobEndDate> element.

The SIF specification defines the meaning of this element as: "This is the date through which the staff assignment is valid (inclusive). Present if the JobStartDate is entered and a JobEndDate is available."

Returns:

The JobEndDate element of this object.

Since:

1.5r1

setJobEndDate

public void setJobEndDate(java.util.Calendar value)

Sets the value of the <JobEndDate> element.

The SIF specification defines the meaning of this element as: "This is the date through which the staff assignment is valid (inclusive). Present if the JobStartDate is entered and a JobEndDate is available."

Parameters:

value - A Calendar object

Since:

1.5r1

getJobFTE

public java.math.BigDecimal getJobFTE()

Gets the value of the <JobFTE> element.

The SIF specification defines the meaning of this element as: "Full-time job equivalent ratio for this assignment. (Format is x.xx; an employee who is full-time and who spends 50% of their time on this assignment would be represented as 0.50)"

Returns:

The JobFTE element of this object.

Since:

1.5r1

setJobFTE

public void setJobFTE(java.math.BigDecimal value)

Sets the value of the <JobFTE> element.

The SIF specification defines the meaning of this element as: "Full-time job equivalent ratio for this assignment. (Format is x.xx; an employee who is full-time and who spends 50% of their time on this assignment would be represented as 0.50)"

Parameters:

value - A BigDecimal object

Since:

1.5r1

setJobClassification

public void setJobClassification(JobClassification value)

Sets the value of the <JobClassification> element.

The SIF specification defines the meaning of this element as: "The specific group of duties or responsibilities of position."

Parameters:

value - A JobClassification object

Since:

1.5r1

setJobClassification

public void setJobClassification(JobClassificationCode code)

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

Parameters:

code -

Since:

1.5r1

getJobClassification

public JobClassification getJobClassification()

Gets the value of the <JobClassification> element.

The SIF specification defines the meaning of this element as: "The specific group of duties or responsibilities of position."

Returns:

A JobClassification object

Since:

1.5r1

removeJobClassification

public void removeJobClassification()

Removes the JobClassification child element previously created by calling setJobClassification

Since:

1.5r1

setProgramType

public void setProgramType(HRProgramType value)

Sets the value of the <ProgramType> element.

The SIF specification defines the meaning of this element as: "The type of instructional or non-instructional program."

Parameters:

value - A HRProgramType object

Since:

1.5r1

getProgramType

public HRProgramType getProgramType()

Gets the value of the <ProgramType> element.

The SIF specification defines the meaning of this element as: "The type of instructional or non-instructional program."

Returns:

An HRProgramType object

Since:

1.5r1

removeProgramType

public void removeProgramType()

Removes the ProgramType child element previously created by calling setProgramType

Since:

1.5r1

setFundingSource

public void setFundingSource(ProgramFundingSource value)

Sets the value of the <FundingSource> element.

The SIF specification defines the meaning of this element as: "Provider of funds for the program or service."

Parameters:

value - A ProgramFundingSource object

Since:

1.5r1

getFundingSource

public ProgramFundingSource getFundingSource()

Gets the value of the <FundingSource> element.

The SIF specification defines the meaning of this element as: "Provider of funds for the program or service."

Returns:

A ProgramFundingSource object

Since:

1.5r1

removeFundingSource

public void removeFundingSource()

Removes the FundingSource child element previously created by calling setFundingSource

Since:

1.5r1

setSISId

public void setSISId(StaffLink value)

Sets the value of the <SISId> element.

The SIF specification defines the meaning of this element as: "A pointer to the StaffPersonal object to be able to establish a link between HR employee objects and SIS staff objects."

Parameters:

value - A StaffLink object

Since:

1.5r1

setSISId

public void setSISId(java.lang.String staffPersonalRefId)

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

Parameters:

staffPersonalRefId - The ID (GUID) of the teacher.

Since:

1.5r1

getSISId

public StaffLink getSISId()

Gets the value of the <SISId> element.

The SIF specification defines the meaning of this element as: "A pointer to the StaffPersonal object to be able to establish a link between HR employee objects and SIS staff objects."

Returns:

A StaffLink object

Since:

1.5r1

removeSISId

public void removeSISId()

Removes the SISId child element previously created by calling setSISId

Since:

1.5r1