com.edustructures.sifworks.library
Class FineInfoList

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFList<T>
              extended by com.edustructures.sifworks.SIFKeyedList<FineInfo>
                  extended by com.edustructures.sifworks.library.FineInfoList
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<FineInfo>, java.util.Collection<FineInfo>

public class FineInfoList
extends SIFKeyedList<FineInfo>

Since:
1.1
Version:
2.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.edustructures.sifworks.Element
CURRENT_SERIALIZE_VERSION
 
Constructor Summary
FineInfoList()
          Constructor
FineInfoList(FineInfo fineInfo)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 void addFineInfo(FineType type, java.util.Calendar assessed, java.math.BigDecimal amount)
          Adds a new <FineInfo> repeatable element.
 FineInfo getFineInfo(FineType type)
          Gets a FineInfo object instance.
 FineInfo[] getFineInfos()
          Gets all FineInfo object instances.
 void removeFineInfo(FineType type)
          Removes a FineInfo object instance.
 void setFineInfos(FineInfo[] fineinfos)
          Sets an array of FineInfo 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

FineInfoList

public FineInfoList()
Constructor


FineInfoList

public FineInfoList(FineInfo fineInfo)
Constructor that accepts values for all mandatory fields

Parameters:
fineInfo -
Method Detail

addFineInfo

public void addFineInfo(FineType type,
                        java.util.Calendar assessed,
                        java.math.BigDecimal amount)
Adds a new <FineInfo> repeatable element. This form of setFineInfo is provided as a convenience method that is functionally equivalent to the version of setFineInfo that accepts a single FineInfo object.

Parameters:
type - Type of fine assessed to this patron and item. A corresponding ItemInfo is required for all FineInfo types except "Other" and "Refund" where it is permissible to omit the ItemInfo element if there isn't an item associated with the fine.
assessed - The date and time that this fine was assessed to the patron.
amount - The current balance of the fine expressed as a positive number.
Since:
1.1

removeFineInfo

public void removeFineInfo(FineType type)
Removes a FineInfo object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:
type - Identifies the FineInfo object to remove by its Type value
Since:
1.1

getFineInfo

public FineInfo getFineInfo(FineType type)
Gets a FineInfo object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:
type - Identifies the FineInfo object to return by its "Type" attribute value
Returns:
A FineInfo object
Since:
1.1

getFineInfos

public FineInfo[] getFineInfos()
Gets all FineInfo object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:
An array of FineInfo objects
Since:
1.1

setFineInfos

public void setFineInfos(FineInfo[] fineinfos)
Sets an array of FineInfo objects. All existing FineInfo instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all FineInfos.

Since:
1.1


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.