com.edustructures.sifworks.library
Class FineInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FineInfo
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

FineInfo()
Constructor

FineInfo(FineType type, java.util.Calendar assessed, java.math.BigDecimal amount)
Constructor that accepts values for all mandatory fields

Method Summary

java.math.BigDecimal	getAmount() Gets the value of the <Amount> element.
java.util.Calendar	getAssessed() Gets the value of the <Assessed> element.
java.lang.String	getDescription() Gets the value of the <Description> 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	getReference() Gets the value of the <Reference> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	setAmount(java.math.BigDecimal value) Sets the value of the <Amount> element.
void	setAssessed(java.util.Calendar value) Sets the value of the <Assessed> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setReference(java.lang.String value) Sets the value of the <Reference> element.
void	setType(FineType 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

FineInfo

public FineInfo()

Constructor

FineInfo

public FineInfo(FineType type,
                java.util.Calendar assessed,
                java.math.BigDecimal amount)

Constructor that accepts values for all mandatory fields

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.

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: "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."

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(FineType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "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."

Parameters:

value - A constant defined by the FineType 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: "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."

Parameters:

value - The value as a String

Since:

1.1

getAssessed

public java.util.Calendar getAssessed()

Gets the value of the <Assessed> element.

The SIF specification defines the meaning of this element as: "The date and time that this fine was assessed to the 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	"Date"
SIF2.0	"Assessed"

Returns:

The Assessed element of this object.

Since:

1.1

setAssessed

public void setAssessed(java.util.Calendar value)

Sets the value of the <Assessed> element.

The SIF specification defines the meaning of this element as: "The date and time that this fine was assessed to the 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	"Date"
SIF2.0	"Assessed"

Parameters:

value - A Calendar object

Since:

1.1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "More detailed information concerning the assessed fine or refund."

Returns:

The Description element of this object.

Since:

1.1

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "More detailed information concerning the assessed fine or refund."

Parameters:

value - A String object

Since:

1.1

getAmount

public java.math.BigDecimal getAmount()

Gets the value of the <Amount> element.

The SIF specification defines the meaning of this element as: "The current balance of the fine expressed as a positive number. "

Returns:

The Amount element of this object.

Since:

1.1

setAmount

public void setAmount(java.math.BigDecimal value)

Sets the value of the <Amount> element.

The SIF specification defines the meaning of this element as: "The current balance of the fine expressed as a positive number. "

Parameters:

value - A BigDecimal object

Since:

1.1

getReference

public java.lang.String getReference()

Gets the value of the <Reference> element.

The SIF specification defines the meaning of this element as: "An application-specific reference identifier for the fine being assessed, paid, or refunded. It is intended to identify a specific fine transaction allowing consumers to include this information in Billing or Payment events sent to the library application."

Returns:

The Reference element of this object.

Since:

2.0

setReference

public void setReference(java.lang.String value)

Sets the value of the <Reference> element.

The SIF specification defines the meaning of this element as: "An application-specific reference identifier for the fine being assessed, paid, or refunded. It is intended to identify a specific fine transaction allowing consumers to include this information in Billing or Payment events sent to the library application."

Parameters:

value - A String object

Since:

2.0