com.edustructures.sifworks.hrfin
Class PayRate

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.hrfin.PayRate

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class PayRate
extends SIFKeyedElement

Per pay distributions

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

PayRate()
Constructor

PayRate(PayRateType type, java.math.BigDecimal amount, java.math.BigDecimal percentage)
Constructor that accepts values for all mandatory fields

Method Summary

java.math.BigDecimal	getAmount() Gets the value of the <Amount> 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.math.BigDecimal	getPercentage() Gets the value of the <Percentage> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	setAmount(java.math.BigDecimal value) Sets the value of the <Amount> element.
void	setPercentage(java.math.BigDecimal value) Sets the value of the <Percentage> element.
void	setType(PayRateType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, 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

PayRate

public PayRate()

Constructor

PayRate

public PayRate(PayRateType type,
               java.math.BigDecimal amount,
               java.math.BigDecimal percentage)

Constructor that accepts values for all mandatory fields

Parameters:

type - Type of pay

amount - Pay amount.

percentage - Percentage of pay this represents.

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

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Type of pay"

Returns:

The Type attribute of this object.

Since:

1.5r1

setType

public void setType(PayRateType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Type of pay"

Parameters:

value - A constant defined by the PayRateType class

Since:

1.5r1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: "Type of pay"

Parameters:

value - The value as a String

Since:

1.5r1

getAmount

public java.math.BigDecimal getAmount()

Gets the value of the <Amount> element.

The SIF specification defines the meaning of this element as: "Pay amount."

Returns:

The Amount element of this object.

Since:

1.5r1

setAmount

public void setAmount(java.math.BigDecimal value)

Sets the value of the <Amount> element.

The SIF specification defines the meaning of this element as: "Pay amount."

Parameters:

value - A BigDecimal object

Since:

1.5r1

getPercentage

public java.math.BigDecimal getPercentage()

Gets the value of the <Percentage> element.

The SIF specification defines the meaning of this element as: "Percentage of pay this represents."

Returns:

The Percentage element of this object.

Since:

1.5r1

setPercentage

public void setPercentage(java.math.BigDecimal value)

Sets the value of the <Percentage> element.

The SIF specification defines the meaning of this element as: "Percentage of pay this represents."

Parameters:

value - A BigDecimal object

Since:

1.5r1