com.edustructures.sifworks.library
Class CheckoutInfo

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFKeyedElement
              extended by com.edustructures.sifworks.library.CheckoutInfo
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class CheckoutInfo
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
CheckoutInfo()
          Constructor
CheckoutInfo(java.util.Calendar returnBy)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 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 getReturnBy()
          Gets the value of the <ReturnBy> element.
 void setReturnBy(java.util.Calendar value)
          Sets the value of the <ReturnBy> element.
 
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

CheckoutInfo

public CheckoutInfo()
Constructor


CheckoutInfo

public CheckoutInfo(java.util.Calendar returnBy)
Constructor that accepts values for all mandatory fields

Parameters:
returnBy - The date and time that this item is due to be returned.
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

getReturnBy

public java.util.Calendar getReturnBy()
Gets the value of the <ReturnBy> element.

The SIF specification defines the meaning of this element as: "The date and time that this item is due to be returned."

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.

VersionTag
1.1"Date"
SIF2.0"ReturnBy"

Returns:
The ReturnBy element of this object.
Since:
1.1

setReturnBy

public void setReturnBy(java.util.Calendar value)
Sets the value of the <ReturnBy> element.

The SIF specification defines the meaning of this element as: "The date and time that this item is due to be returned."

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.

VersionTag
1.1"Date"
SIF2.0"ReturnBy"

Parameters:
value - A Calendar object
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.