com.edustructures.sifworks.hrfin
Class EmployeeWage

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.EmployeeWage
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class EmployeeWage
extends SIFDataObject

This object contains HR/payroll employee information used to define how to pay an employee per pay cycle. 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
EmployeeWage()
          Constructor
EmployeeWage(java.lang.String refId, java.lang.String employeePersonalRefId, PayRates payRates)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 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
 PayRates getPayRates()
          Gets the value of the <PayRates> element.
 java.lang.String getRefId()
          Gets the value of the RefId attribute.
 void removePayRates()
          Removes the PayRates child element previously created by calling setPayRates
 void setEmployeePersonalRefId(java.lang.String value)
          Sets the value of the EmployeePersonalRefId attribute.
 void setPayRates(PayRates value)
          Sets the value of the <PayRates> element.
 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

EmployeeWage

public EmployeeWage()
Constructor


EmployeeWage

public EmployeeWage(java.lang.String refId,
                    java.lang.String employeePersonalRefId,
                    PayRates payRates)
Constructor that accepts values for all mandatory fields

Parameters:
refId - The GUID of the employee's pay information.
employeePersonalRefId - The GUID that refers to the EmployeePersonal object.
payRates - Per pay distributions
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's pay 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's pay 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

setPayRates

public void setPayRates(PayRates value)
Sets the value of the <PayRates> element.

The SIF specification defines the meaning of this element as: "Per pay distributions"

Parameters:
value - A PayRates object
Since:
1.5r1

getPayRates

public PayRates getPayRates()
Gets the value of the <PayRates> element.

The SIF specification defines the meaning of this element as: "Per pay distributions"

Returns:
A PayRates object
Since:
1.5r1

removePayRates

public void removePayRates()
Removes the PayRates child element previously created by calling setPayRates

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.