com.edustructures.sifworks.food
Class Agencies

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Agency>
                  com.edustructures.sifworks.food.Agencies

All Implemented Interfaces:

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

public class Agencies
extends SIFKeyedList<Agency>

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Agencies()
Constructor

Agencies(Agency agency)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAgency(AgencyTypeCode type, java.lang.String name, Rates rates) Adds a new <Agency> repeatable element.
Agency	getAgency(AgencyTypeCode type) Gets an Agency object instance.
Agency[]	getAgencys() Gets all Agency object instances.
void	removeAgency(AgencyTypeCode type) Removes an Agency object instance.
void	setAgencys(Agency[] agencys) Sets an array of Agency 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

Agencies

public Agencies()

Constructor

Agencies

public Agencies(Agency agency)

Constructor that accepts values for all mandatory fields

Parameters:

agency -

Method Detail

addAgency

public void addAgency(AgencyTypeCode type,
                      java.lang.String name,
                      Rates rates)

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

Parameters:

type - Type of the reimbursing agency. Values: Federal, State, Local, Other

name - The name of the reimbursing agency. This element is to be used when the Type is set as Other.

rates -

Since:

2.0

removeAgency

public void removeAgency(AgencyTypeCode type)

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

Parameters:

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

Since:

2.0

getAgency

public Agency getAgency(AgencyTypeCode type)

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

Parameters:

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

Returns:

An Agency object

Since:

2.0

getAgencys

public Agency[] getAgencys()

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

Returns:

An array of Agency objects

Since:

2.0

setAgencys

public void setAgencys(Agency[] agencys)

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

Since:

2.0