com.edustructures.sifworks.hrfin
Class EmployeeContract

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFDataObject
              extended by com.edustructures.sifworks.hrfin.EmployeeContract
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class EmployeeContract
extends SIFDataObject

This object contains HR contract information related to 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
EmployeeContract()
          Constructor
EmployeeContract(java.lang.String refId, java.lang.String employeePersonalRefId, java.math.BigDecimal baseSalary, java.util.Calendar contractStartDate, java.util.Calendar contractEndDate)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 java.lang.Integer getAssignmentDays()
          Gets the value of the <AssignmentDays> element.
 java.math.BigDecimal getBaseSalary()
          Gets the value of the <BaseSalary> element.
 java.lang.Integer getContractDays()
          Gets the value of the <ContractDays> element.
 java.util.Calendar getContractEndDate()
          Gets the value of the <ContractEndDate> element.
 java.util.Calendar getContractStartDate()
          Gets the value of the <ContractStartDate> element.
 java.lang.String getContractTerm()
          Gets the value of the <ContractTerm> element.
 java.lang.String getEmployeePersonalRefId()
          Gets the value of the EmployeePersonalRefId attribute.
 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 getRefId()
          Gets the value of the RefId attribute.
 void setAssignmentDays(java.lang.Integer value)
          Sets the value of the <AssignmentDays> element.
 void setBaseSalary(java.math.BigDecimal value)
          Sets the value of the <BaseSalary> element.
 void setContractDays(java.lang.Integer value)
          Sets the value of the <ContractDays> element.
 void setContractEndDate(java.util.Calendar value)
          Sets the value of the <ContractEndDate> element.
 void setContractStartDate(java.util.Calendar value)
          Sets the value of the <ContractStartDate> element.
 void setContractTerm(ContractualTermCode value)
          Sets the value of the <ContractTerm> element.
 void setContractTerm(java.lang.String value)
          Sets the value of the <ContractTerm> element as a String.
 void setEmployeePersonalRefId(java.lang.String value)
          Sets the value of the EmployeePersonalRefId attribute.
 void setRefId(java.lang.String value)
          Sets the value of the RefId attribute.
 
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

EmployeeContract

public EmployeeContract()
Constructor


EmployeeContract

public EmployeeContract(java.lang.String refId,
                        java.lang.String employeePersonalRefId,
                        java.math.BigDecimal baseSalary,
                        java.util.Calendar contractStartDate,
                        java.util.Calendar contractEndDate)
Constructor that accepts values for all mandatory fields

Parameters:
refId - The GUID of the employee contract information.
employeePersonalRefId - The GUID that refers to the EmployeePersonal object.
baseSalary - Base salary of employee for this contact in whole dollars
contractStartDate - Contractual start date.
contractEndDate - Contractual ending date.
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 of the employee contract information."

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 of the employee contract information."

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: "The GUID that refers to the 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: "The GUID that refers to the EmployeePersonal object."

Parameters:
value - A String object
Since:
1.5r1

getBaseSalary

public java.math.BigDecimal getBaseSalary()
Gets the value of the <BaseSalary> element.

The SIF specification defines the meaning of this element as: "Base salary of employee for this contact in whole dollars"

Returns:
The BaseSalary element of this object.
Since:
1.5r1

setBaseSalary

public void setBaseSalary(java.math.BigDecimal value)
Sets the value of the <BaseSalary> element.

The SIF specification defines the meaning of this element as: "Base salary of employee for this contact in whole dollars"

Parameters:
value - A BigDecimal object
Since:
1.5r1

getContractStartDate

public java.util.Calendar getContractStartDate()
Gets the value of the <ContractStartDate> element.

The SIF specification defines the meaning of this element as: "Contractual start date."

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.

VersionTag
1.5r1"ContractStart"
SIF2.0"ContractStartDate"

Returns:
The ContractStartDate element of this object.
Since:
1.5r1

setContractStartDate

public void setContractStartDate(java.util.Calendar value)
Sets the value of the <ContractStartDate> element.

The SIF specification defines the meaning of this element as: "Contractual start date."

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.

VersionTag
1.5r1"ContractStart"
SIF2.0"ContractStartDate"

Parameters:
value - A Calendar object
Since:
1.5r1

getContractEndDate

public java.util.Calendar getContractEndDate()
Gets the value of the <ContractEndDate> element.

The SIF specification defines the meaning of this element as: "Contractual ending date."

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.

VersionTag
1.5r1"ContractEnd"
SIF2.0"ContractEndDate"

Returns:
The ContractEndDate element of this object.
Since:
1.5r1

setContractEndDate

public void setContractEndDate(java.util.Calendar value)
Sets the value of the <ContractEndDate> element.

The SIF specification defines the meaning of this element as: "Contractual ending date."

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.

VersionTag
1.5r1"ContractEnd"
SIF2.0"ContractEndDate"

Parameters:
value - A Calendar object
Since:
1.5r1

getContractTerm

public java.lang.String getContractTerm()
Gets the value of the <ContractTerm> element.

The SIF specification defines the meaning of this element as: "Contractual Term in school years"

Returns:
The ContractTerm element of this object.
Since:
1.5r1

setContractTerm

public void setContractTerm(ContractualTermCode value)
Sets the value of the <ContractTerm> element.

The SIF specification defines the meaning of this element as: "Contractual Term in school years"

Parameters:
value - A constant defined by the ContractualTermCode class
Since:
1.5r1

setContractTerm

public void setContractTerm(java.lang.String value)
Sets the value of the <ContractTerm> element as a String.

The SIF specification defines the meaning of this element as: "Contractual Term in school years"

Parameters:
value - The value as a String
Since:
1.5r1

getContractDays

public java.lang.Integer getContractDays()
Gets the value of the <ContractDays> element.

The SIF specification defines the meaning of this element as: "Number of days in service for contract total"

Returns:
The ContractDays element of this object.
Since:
1.5r1

setContractDays

public void setContractDays(java.lang.Integer value)
Sets the value of the <ContractDays> element.

The SIF specification defines the meaning of this element as: "Number of days in service for contract total"

Parameters:
value - A Integer object
Since:
1.5r1

getAssignmentDays

public java.lang.Integer getAssignmentDays()
Gets the value of the <AssignmentDays> element.

The SIF specification defines the meaning of this element as: "Number of days per year employee is expected to work in this assignment"

Returns:
The AssignmentDays element of this object.
Since:
1.5r1

setAssignmentDays

public void setAssignmentDays(java.lang.Integer value)
Sets the value of the <AssignmentDays> element.

The SIF specification defines the meaning of this element as: "Number of days per year employee is expected to work in this assignment"

Parameters:
value - A Integer object
Since:
1.5r1


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.