com.edustructures.sifworks.library
Class HoldInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.library.HoldInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class HoldInfo
extends SIFKeyedElement

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

HoldInfo()
Constructor

HoldInfo(HoldStatus type, java.util.Calendar datePlaced)
Constructor that accepts values for all mandatory fields

Method Summary

java.util.Calendar	getDateNeeded() Gets the value of the <DateNeeded> element.
java.util.Calendar	getDatePlaced() Gets the value of the <DatePlaced> element.
java.util.Calendar	getExpires() Gets the value of the <Expires> 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.util.Calendar	getMadeAvailable() Gets the value of the <MadeAvailable> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	setDateNeeded(java.util.Calendar value) Sets the value of the <DateNeeded> element.
void	setDatePlaced(java.util.Calendar value) Sets the value of the <DatePlaced> element.
void	setExpires(java.util.Calendar value) Sets the value of the <Expires> element.
void	setMadeAvailable(java.util.Calendar value) Sets the value of the <MadeAvailable> element.
void	setType(HoldStatus 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

HoldInfo

public HoldInfo()

Constructor

HoldInfo

public HoldInfo(HoldStatus type,
                java.util.Calendar datePlaced)

Constructor that accepts values for all mandatory fields

Parameters:

type - The type of hold being referenced.

datePlaced - The date that the patron placed the hold.

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: "The type of hold being referenced."

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(HoldStatus value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "The type of hold being referenced."

Parameters:

value - A constant defined by the HoldStatus class

Since:

1.1

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: "The type of hold being referenced."

Parameters:

value - The value as a String

Since:

1.1

getDatePlaced

public java.util.Calendar getDatePlaced()

Gets the value of the <DatePlaced> element.

The SIF specification defines the meaning of this element as: "The date that the patron placed the hold."

Returns:

The DatePlaced element of this object.

Since:

1.1

setDatePlaced

public void setDatePlaced(java.util.Calendar value)

Sets the value of the <DatePlaced> element.

The SIF specification defines the meaning of this element as: "The date that the patron placed the hold."

Parameters:

value - A Calendar object

Since:

1.1

getDateNeeded

public java.util.Calendar getDateNeeded()

Gets the value of the <DateNeeded> element.

The SIF specification defines the meaning of this element as: "The date that the patron needs this item by."

Returns:

The DateNeeded element of this object.

Since:

1.1

setDateNeeded

public void setDateNeeded(java.util.Calendar value)

Sets the value of the <DateNeeded> element.

The SIF specification defines the meaning of this element as: "The date that the patron needs this item by."

Parameters:

value - A Calendar object

Since:

1.1

getMadeAvailable

public java.util.Calendar getMadeAvailable()

Gets the value of the <MadeAvailable> element.

The SIF specification defines the meaning of this element as: "The date that this item became available for the patron to pick up."

Returns:

The MadeAvailable element of this object.

Since:

1.1

setMadeAvailable

public void setMadeAvailable(java.util.Calendar value)

Sets the value of the <MadeAvailable> element.

The SIF specification defines the meaning of this element as: "The date that this item became available for the patron to pick up."

Parameters:

value - A Calendar object

Since:

1.1

getExpires

public java.util.Calendar getExpires()

Gets the value of the <Expires> element.

The SIF specification defines the meaning of this element as: "The date when this ready hold will expire freeing the item to be assigned to another patron."

Returns:

The Expires element of this object.

Since:

1.1

setExpires

public void setExpires(java.util.Calendar value)

Sets the value of the <Expires> element.

The SIF specification defines the meaning of this element as: "The date when this ready hold will expire freeing the item to be assigned to another patron."

Parameters:

value - A Calendar object

Since:

1.1