com.edustructures.sifworks.library
Class HoldInfoList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<HoldInfo>
                  com.edustructures.sifworks.library.HoldInfoList

All Implemented Interfaces:

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

public class HoldInfoList
extends SIFKeyedList<HoldInfo>

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

HoldInfoList()
Constructor

HoldInfoList(HoldInfo holdInfo)
Constructor that accepts values for all mandatory fields

Method Summary

void	addHoldInfo(HoldStatus type, java.util.Calendar datePlaced) Adds a new <HoldInfo> repeatable element.
HoldInfo	getHoldInfo(HoldStatus type) Gets an HoldInfo object instance.
HoldInfo[]	getHoldInfos() Gets all HoldInfo object instances.
void	removeHoldInfo(HoldStatus type) Removes an HoldInfo object instance.
void	setHoldInfos(HoldInfo[] holdinfos) Sets an array of HoldInfo 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

HoldInfoList

public HoldInfoList()

Constructor

HoldInfoList

public HoldInfoList(HoldInfo holdInfo)

Constructor that accepts values for all mandatory fields

Parameters:

holdInfo -

Method Detail

addHoldInfo

public void addHoldInfo(HoldStatus type,
                        java.util.Calendar datePlaced)

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

Parameters:

type - The type of hold being referenced.

datePlaced - The date that the patron placed the hold.

Since:

1.1

removeHoldInfo

public void removeHoldInfo(HoldStatus type)

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

Parameters:

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

Since:

1.1

getHoldInfo

public HoldInfo getHoldInfo(HoldStatus type)

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

Parameters:

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

Returns:

An HoldInfo object

Since:

1.1

getHoldInfos

public HoldInfo[] getHoldInfos()

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

Returns:

An array of HoldInfo objects

Since:

1.1

setHoldInfos

public void setHoldInfos(HoldInfo[] holdinfos)

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

Since:

1.1