com.edustructures.sifworks.hrfin
Class TimeWorked

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TimeWorked
extends SIFDataObject

This object contains information about the time worked by an employee on a specific job. 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

TimeWorked()
Constructor

TimeWorked(java.lang.String refId, java.lang.String employeePersonalRefId, java.lang.String locationInfoRefId, java.lang.String payPeriod)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getEmployeePersonalRefId() Gets the value of the <EmployeePersonalRefId> element.
JobFunction	getJobFunction() Gets the value of the <JobFunction> 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.math.BigDecimal	getOvertimeHours() Gets the value of the <OvertimeHours> element.
java.lang.String	getPayPeriod() Gets the value of the <PayPeriod> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.math.BigDecimal	getRegularHours() Gets the value of the <RegularHours> element.
void	removeJobFunction() Removes the JobFunction child element previously created by calling setJobFunction
void	setEmployeePersonalRefId(java.lang.String value) Sets the value of the <EmployeePersonalRefId> element.
void	setJobFunction(JobFunction value) Sets the value of the <JobFunction> element.
void	setJobFunction(JobFunctionCode code) Sets the value of the <JobFunction> child element.
void	setLocationInfoRefId(java.lang.String value) Sets the value of the <LocationInfoRefId> element.
void	setOvertimeHours(java.math.BigDecimal value) Sets the value of the <OvertimeHours> element.
void	setPayPeriod(java.lang.String value) Sets the value of the <PayPeriod> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setRegularHours(java.math.BigDecimal value) Sets the value of the <RegularHours> 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

TimeWorked

public TimeWorked()

Constructor

TimeWorked

public TimeWorked(java.lang.String refId,
                  java.lang.String employeePersonalRefId,
                  java.lang.String locationInfoRefId,
                  java.lang.String payPeriod)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID for this object. The application that owns this object is responsible for generating this unique ID.

employeePersonalRefId - References associated EmployeePersonal object.

locationInfoRefId - Site where employee actually worked. References LocationInfo object.

payPeriod - Pay period hours were worked in.

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: "GUID for this object. The application that owns this object is responsible for generating this unique ID."

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: "GUID for this object. The application that owns this object is responsible for generating this unique ID."

Parameters:

value - A String object

Since:

1.5r1

getEmployeePersonalRefId

public java.lang.String getEmployeePersonalRefId()

Gets the value of the <EmployeePersonalRefId> element.

The SIF specification defines the meaning of this element as: "References associated EmployeePersonal 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	"EmployeeId"
SIF2.0	"EmployeePersonalRefId"

Returns:

The EmployeePersonalRefId element of this object.

Since:

1.5r1

setEmployeePersonalRefId

public void setEmployeePersonalRefId(java.lang.String value)

Sets the value of the <EmployeePersonalRefId> element.

The SIF specification defines the meaning of this element as: "References associated EmployeePersonal 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	"EmployeeId"
SIF2.0	"EmployeePersonalRefId"

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: "Site where employee actually worked. References 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	"EmployeeSiteId"
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: "Site where employee actually worked. References 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	"EmployeeSiteId"
SIF2.0	"LocationInfoRefId"

Parameters:

value - A String object

Since:

1.5r1

setJobFunction

public void setJobFunction(JobFunction value)

Sets the value of the <JobFunction> element.

The SIF specification defines the meaning of this element as: "The purpose of the activities as related to students."

Parameters:

value - A JobFunction object

Since:

1.5r1

setJobFunction

public void setJobFunction(JobFunctionCode code)

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

Parameters:

code - Code representing the type of job function.

Since:

1.5r1

getJobFunction

public JobFunction getJobFunction()

Gets the value of the <JobFunction> element.

The SIF specification defines the meaning of this element as: "The purpose of the activities as related to students."

Returns:

A JobFunction object

Since:

1.5r1

removeJobFunction

public void removeJobFunction()

Removes the JobFunction child element previously created by calling setJobFunction

Since:

1.5r1

getRegularHours

public java.math.BigDecimal getRegularHours()

Gets the value of the <RegularHours> element.

The SIF specification defines the meaning of this element as: "Regular hours worked. Enter 0 if no hours worked."

Returns:

The RegularHours element of this object.

Since:

1.5r1

setRegularHours

public void setRegularHours(java.math.BigDecimal value)

Sets the value of the <RegularHours> element.

The SIF specification defines the meaning of this element as: "Regular hours worked. Enter 0 if no hours worked."

Parameters:

value - A BigDecimal object

Since:

1.5r1

getOvertimeHours

public java.math.BigDecimal getOvertimeHours()

Gets the value of the <OvertimeHours> element.

The SIF specification defines the meaning of this element as: "Overtime hours worked. Enter 0 if no overtime hours worked."

Returns:

The OvertimeHours element of this object.

Since:

1.5r1

setOvertimeHours

public void setOvertimeHours(java.math.BigDecimal value)

Sets the value of the <OvertimeHours> element.

The SIF specification defines the meaning of this element as: "Overtime hours worked. Enter 0 if no overtime hours worked."

Parameters:

value - A BigDecimal object

Since:

1.5r1

getPayPeriod

public java.lang.String getPayPeriod()

Gets the value of the <PayPeriod> element.

The SIF specification defines the meaning of this element as: "Pay period hours were worked in."

Returns:

The PayPeriod element of this object.

Since:

1.5r1

setPayPeriod

public void setPayPeriod(java.lang.String value)

Sets the value of the <PayPeriod> element.

The SIF specification defines the meaning of this element as: "Pay period hours were worked in."

Parameters:

value - A String object

Since:

1.5r1