com.edustructures.sifworks.hrfin
Class PayRates

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<PayRate>
                  com.edustructures.sifworks.hrfin.PayRates

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<PayRate>, java.util.Collection<PayRate>

public class PayRates
extends SIFKeyedList<PayRate>

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

PayRates()
Constructor

PayRates(PayRate payRate)
Constructor that accepts values for all mandatory fields

Method Summary

void	addPayRate(PayRateType type, java.math.BigDecimal amount, java.math.BigDecimal percentage) Adds a new <PayRate> repeatable element.
PayRate	getPayRate(PayRateType type) Gets a PayRate object instance.
PayRate[]	getPayRates() Gets all PayRate object instances.
void	removePayRate(PayRateType type) Removes a PayRate object instance.
void	setPayRates(PayRate[] payrates) Sets an array of PayRate objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

PayRates

public PayRates()

Constructor

PayRates

public PayRates(PayRate payRate)

Constructor that accepts values for all mandatory fields

Parameters:

payRate - NCES 0229 Program Type Codeset

Method Detail

addPayRate

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

Adds a new <PayRate> repeatable element. This form of setPayRate is provided as a convenience method that is functionally equivalent to the version of setPayRate that accepts a single PayRate object.

Parameters:

type - Type of pay

amount - Pay amount.

percentage - Percentage of pay this represents.

Since:

1.5r1

removePayRate

public void removePayRate(PayRateType type)

Removes a PayRate object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

type - Identifies the PayRate object to remove by its Type value

Since:

1.5r1

getPayRate

public PayRate getPayRate(PayRateType type)

Gets a PayRate object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

type - Identifies the PayRate object to return by its "Type" attribute value

Returns:

A PayRate object

Since:

1.5r1

getPayRates

public PayRate[] getPayRates()

Gets all PayRate object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of PayRate objects

Since:

1.5r1

setPayRates

public void setPayRates(PayRate[] payrates)

Sets an array of PayRate objects. All existing PayRate instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all PayRates.

Since:

1.5r1