com.edustructures.sifworks.library
Class LibraryPatronStatus

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.library.LibraryPatronStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LibraryPatronStatus
extends SIFDataObject

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

LibraryPatronStatus()
Constructor

LibraryPatronStatus(java.lang.String libraryType, java.lang.String sifRefId, PatronType sifRefObject, ElectronicIdList electronicIdList, java.lang.Integer numberOfCheckouts, java.lang.Integer numberOfOverdues, java.lang.Integer numberOfFines, java.math.BigDecimal fineAmount)
Constructor that accepts values for all mandatory fields

Method Summary

ElectronicIdList	getElectronicIdList() Gets the value of the <ElectronicIdList> element.
java.math.BigDecimal	getFineAmount() Gets the value of the <FineAmount> 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.lang.String	getLibraryType() Gets the value of the LibraryType attribute.
MessageList	getMessageList() Gets the value of the <MessageList> element.
java.lang.Integer	getNumberOfCheckouts() Gets the value of the <NumberOfCheckouts> element.
java.lang.Integer	getNumberOfFines() Gets the value of the <NumberOfFines> element.
java.lang.Integer	getNumberOfOverdues() Gets the value of the <NumberOfOverdues> element.
java.lang.Integer	getNumberOfRefunds() Gets the value of the <NumberOfRefunds> element.
java.math.BigDecimal	getRefundAmount() Gets the value of the <RefundAmount> element.
java.lang.String	getSIF_RefId() Gets the value of the SIF_RefId attribute.
java.lang.String	getSIF_RefObject() Gets the value of the SIF_RefObject attribute.
TransactionList	getTransactionList() Gets the value of the <TransactionList> element.
void	removeElectronicIdList() Removes the ElectronicIdList child element previously created by calling setElectronicIdList
void	removeMessageList() Removes the MessageList child element previously created by calling setMessageList
void	removeTransactionList() Removes the TransactionList child element previously created by calling setTransactionList
void	setElectronicIdList(ElectronicIdList value) Sets the value of the <ElectronicIdList> element.
void	setFineAmount(java.math.BigDecimal value) Sets the value of the <FineAmount> element.
void	setLibraryType(java.lang.String value) Sets the value of the LibraryType attribute.
void	setMessageList(MessageList value) Sets the value of the <MessageList> element.
void	setNumberOfCheckouts(java.lang.Integer value) Sets the value of the <NumberOfCheckouts> element.
void	setNumberOfFines(java.lang.Integer value) Sets the value of the <NumberOfFines> element.
void	setNumberOfOverdues(java.lang.Integer value) Sets the value of the <NumberOfOverdues> element.
void	setNumberOfRefunds(java.lang.Integer value) Sets the value of the <NumberOfRefunds> element.
void	setRefundAmount(java.math.BigDecimal value) Sets the value of the <RefundAmount> element.
void	setSIF_RefId(java.lang.String value) Sets the value of the SIF_RefId attribute.
void	setSIF_RefObject(PatronType value) Sets the value of the SIF_RefObject attribute.
void	setSIF_RefObject(java.lang.String value) Sets the value of the SIF_RefObject attribute as a String.
void	setTransactionList(TransactionList value) Sets the value of the <TransactionList> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getRefId, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

LibraryPatronStatus

public LibraryPatronStatus()

Constructor

LibraryPatronStatus

public LibraryPatronStatus(java.lang.String libraryType,
                           java.lang.String sifRefId,
                           PatronType sifRefObject,
                           ElectronicIdList electronicIdList,
                           java.lang.Integer numberOfCheckouts,
                           java.lang.Integer numberOfOverdues,
                           java.lang.Integer numberOfFines,
                           java.math.BigDecimal fineAmount)

Constructor that accepts values for all mandatory fields

Parameters:

libraryType - A library-defined language-independent value that refers to a specific patron type.

sifRefId - The SIF wide unique identifier of a student or teacher.

sifRefObject - The type of patron mapped to a SIF supported object. Library automation products work with patrons who could be students or teachers.

electronicIdList - This is an open list with no primary key.

numberOfCheckouts - The total number of items that this patron currently has checked out including overdue items.

numberOfOverdues - The total number of checkouts that are currently overdue.

numberOfFines - The total number of fines currently assessed to this patron.

fineAmount - The total monetary amount of the fines that this patron currently owes the library expressed as a positive number.

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

getLibraryType

public java.lang.String getLibraryType()

Gets the value of the LibraryType attribute.

The SIF specification defines the meaning of this attribute as: "A library-defined language-independent value that refers to a specific patron type."

Returns:

The LibraryType attribute of this object.

Since:

1.1

setLibraryType

public void setLibraryType(java.lang.String value)

Sets the value of the LibraryType attribute.

The SIF specification defines the meaning of this attribute as: "A library-defined language-independent value that refers to a specific patron type."

Parameters:

value - A String object

Since:

1.1

getSIF_RefId

public java.lang.String getSIF_RefId()

Gets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "The SIF wide unique identifier of a student or teacher."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.1	"SifRefId"
SIF2.0	"SIF_RefId"

Returns:

The SIF_RefId attribute of this object.

Since:

1.1

setSIF_RefId

public void setSIF_RefId(java.lang.String value)

Sets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "The SIF wide unique identifier of a student or teacher."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.1	"SifRefId"
SIF2.0	"SIF_RefId"

Parameters:

value - A String object

Since:

1.1

getSIF_RefObject

public java.lang.String getSIF_RefObject()

Gets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "The type of patron mapped to a SIF supported object. Library automation products work with patrons who could be students or teachers."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.1	"SifRefIdType"
SIF2.0	"SIF_RefObject"

Returns:

The SIF_RefObject attribute of this object.

Since:

1.1

setSIF_RefObject

public void setSIF_RefObject(PatronType value)

Sets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "The type of patron mapped to a SIF supported object. Library automation products work with patrons who could be students or teachers."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.1	"SifRefIdType"
SIF2.0	"SIF_RefObject"

Parameters:

value - A constant defined by the PatronType class

Since:

1.1

setSIF_RefObject

public void setSIF_RefObject(java.lang.String value)

Sets the value of the SIF_RefObject attribute as a String.

The SIF specification defines the meaning of this attribute as: "The type of patron mapped to a SIF supported object. Library automation products work with patrons who could be students or teachers."

This attribute is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering attributes of this kind.

Version	Tag
1.1	"SifRefIdType"
SIF2.0	"SIF_RefObject"

Parameters:

value - The value as a String

Since:

1.1

setElectronicIdList

public void setElectronicIdList(ElectronicIdList value)

Sets the value of the <ElectronicIdList> element.

The SIF specification defines the meaning of this element as: "This is an open list with no primary key."

Parameters:

value - A ElectronicIdList object

Since:

1.1

getElectronicIdList

public ElectronicIdList getElectronicIdList()

Gets the value of the <ElectronicIdList> element.

The SIF specification defines the meaning of this element as: "This is an open list with no primary key."

Returns:

An ElectronicIdList object

Since:

1.1

removeElectronicIdList

public void removeElectronicIdList()

Removes the ElectronicIdList child element previously created by calling setElectronicIdList

Since:

1.1

setTransactionList

public void setTransactionList(TransactionList value)

Sets the value of the <TransactionList> element.

Parameters:

value - A TransactionList object

Since:

1.1

getTransactionList

public TransactionList getTransactionList()

Gets the value of the <TransactionList> element.

Returns:

A TransactionList object

Since:

1.1

removeTransactionList

public void removeTransactionList()

Removes the TransactionList child element previously created by calling setTransactionList

Since:

1.1

setMessageList

public void setMessageList(MessageList value)

Sets the value of the <MessageList> element.

Parameters:

value - A MessageList object

Since:

1.1

getMessageList

public MessageList getMessageList()

Gets the value of the <MessageList> element.

Returns:

A MessageList object

Since:

1.1

removeMessageList

public void removeMessageList()

Removes the MessageList child element previously created by calling setMessageList

Since:

1.1

getNumberOfCheckouts

public java.lang.Integer getNumberOfCheckouts()

Gets the value of the <NumberOfCheckouts> element.

The SIF specification defines the meaning of this element as: "The total number of items that this patron currently has checked out including overdue items."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"NumCheckouts"
SIF2.0	"NumberOfCheckouts"

Returns:

The NumberOfCheckouts element of this object.

Since:

1.1

setNumberOfCheckouts

public void setNumberOfCheckouts(java.lang.Integer value)

Sets the value of the <NumberOfCheckouts> element.

The SIF specification defines the meaning of this element as: "The total number of items that this patron currently has checked out including overdue items."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"NumCheckouts"
SIF2.0	"NumberOfCheckouts"

Parameters:

value - A Integer object

Since:

1.1

getNumberOfOverdues

public java.lang.Integer getNumberOfOverdues()

Gets the value of the <NumberOfOverdues> element.

The SIF specification defines the meaning of this element as: "The total number of checkouts that are currently overdue."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"NumOverdues"
SIF2.0	"NumberOfOverdues"

Returns:

The NumberOfOverdues element of this object.

Since:

1.1

setNumberOfOverdues

public void setNumberOfOverdues(java.lang.Integer value)

Sets the value of the <NumberOfOverdues> element.

The SIF specification defines the meaning of this element as: "The total number of checkouts that are currently overdue."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"NumOverdues"
SIF2.0	"NumberOfOverdues"

Parameters:

value - A Integer object

Since:

1.1

getNumberOfFines

public java.lang.Integer getNumberOfFines()

Gets the value of the <NumberOfFines> element.

The SIF specification defines the meaning of this element as: "The total number of fines currently assessed to this patron."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"NumFines"
SIF2.0	"NumberOfFines"

Returns:

The NumberOfFines element of this object.

Since:

1.1

setNumberOfFines

public void setNumberOfFines(java.lang.Integer value)

Sets the value of the <NumberOfFines> element.

The SIF specification defines the meaning of this element as: "The total number of fines currently assessed to this patron."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"NumFines"
SIF2.0	"NumberOfFines"

Parameters:

value - A Integer object

Since:

1.1

getFineAmount

public java.math.BigDecimal getFineAmount()

Gets the value of the <FineAmount> element.

The SIF specification defines the meaning of this element as: "The total monetary amount of the fines that this patron currently owes the library expressed as a positive number."

Returns:

The FineAmount element of this object.

Since:

1.1

setFineAmount

public void setFineAmount(java.math.BigDecimal value)

Sets the value of the <FineAmount> element.

The SIF specification defines the meaning of this element as: "The total monetary amount of the fines that this patron currently owes the library expressed as a positive number."

Parameters:

value - A BigDecimal object

Since:

1.1

getNumberOfRefunds

public java.lang.Integer getNumberOfRefunds()

Gets the value of the <NumberOfRefunds> element.

The SIF specification defines the meaning of this element as: "The total number of refunds currently credited to this patron."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"NumRefunds"
SIF2.0	"NumberOfRefunds"

Returns:

The NumberOfRefunds element of this object.

Since:

1.1

setNumberOfRefunds

public void setNumberOfRefunds(java.lang.Integer value)

Sets the value of the <NumberOfRefunds> element.

The SIF specification defines the meaning of this element as: "The total number of refunds currently credited to this patron."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.1	"NumRefunds"
SIF2.0	"NumberOfRefunds"

Parameters:

value - A Integer object

Since:

1.1

getRefundAmount

public java.math.BigDecimal getRefundAmount()

Gets the value of the <RefundAmount> element.

The SIF specification defines the meaning of this element as: "The total monetary amount of the refunds that the library currently owes the patron expressed as a positive number."

Returns:

The RefundAmount element of this object.

Since:

1.1

setRefundAmount

public void setRefundAmount(java.math.BigDecimal value)

Sets the value of the <RefundAmount> element.

The SIF specification defines the meaning of this element as: "The total monetary amount of the refunds that the library currently owes the patron expressed as a positive number."

Parameters:

value - A BigDecimal object

Since:

1.1