com.edustructures.sifworks.library
Class ItemInfo

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.ItemInfo
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class ItemInfo
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
ItemInfo()
          Constructor
ItemInfo(ItemType type, java.lang.String title)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 java.lang.String getAuthor()
          Gets the value of the <Author> element.
 java.lang.String getCallNumber()
          Gets the value of the <CallNumber> element.
 ElectronicId getElectronicId()
          Gets the value of the <ElectronicId> 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.math.BigDecimal getPrice()
          Gets the value of the <Price> element.
 java.lang.String getTitle()
          Gets the value of the <Title> element.
 java.lang.String getType()
          Gets the value of the Type attribute.
 void removeElectronicId()
          Removes the ElectronicId child element previously created by calling setElectronicId
 void setAuthor(java.lang.String value)
          Sets the value of the <Author> element.
 void setCallNumber(java.lang.String value)
          Sets the value of the <CallNumber> element.
 void setElectronicId(ElectronicId value)
          Sets the value of the <ElectronicId> element.
 void setElectronicId(ElectronicIdType type, java.lang.String value)
          Sets the value of the <ElectronicId> child element.
 void setPrice(java.math.BigDecimal value)
          Sets the value of the <Price> element.
 void setTitle(java.lang.String value)
          Sets the value of the <Title> element.
 void setType(ItemType 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

ItemInfo

public ItemInfo()
Constructor


ItemInfo

public ItemInfo(ItemType type,
                java.lang.String title)
Constructor that accepts values for all mandatory fields

Parameters:
type -
title - The title of the item being referenced by this Transaction.
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.

Returns:
The Type attribute of this object.
Since:
1.1

setType

public void setType(ItemType value)
Sets the value of the Type attribute.

Parameters:
value - A constant defined by the ItemType class
Since:
1.1

setType

public void setType(java.lang.String value)
Sets the value of the Type attribute as a String.

Parameters:
value - The value as a String
Since:
1.1

getTitle

public java.lang.String getTitle()
Gets the value of the <Title> element.

The SIF specification defines the meaning of this element as: "The title of the item being referenced by this Transaction."

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"ItemTitle"
SIF2.0"Title"

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

setTitle

public void setTitle(java.lang.String value)
Sets the value of the <Title> element.

The SIF specification defines the meaning of this element as: "The title of the item being referenced by this Transaction."

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"ItemTitle"
SIF2.0"Title"

Parameters:
value - A String object
Since:
1.1

getAuthor

public java.lang.String getAuthor()
Gets the value of the <Author> element.

The SIF specification defines the meaning of this element as: "The author of the item being referenced by this Transaction."

Returns:
The Author element of this object.
Since:
2.0

setAuthor

public void setAuthor(java.lang.String value)
Sets the value of the <Author> element.

The SIF specification defines the meaning of this element as: "The author of the item being referenced by this Transaction."

Parameters:
value - A String object
Since:
2.0

setElectronicId

public void setElectronicId(ElectronicId value)
Sets the value of the <ElectronicId> element.

The SIF specification defines the meaning of this element as: "Electronic identifier associated with this Transaction."

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"ItemElectronicId"
SIF2.0"ElectronicId"

Parameters:
value - A ElectronicId object
Since:
1.1

setElectronicId

public void setElectronicId(ElectronicIdType type,
                            java.lang.String value)
Sets the value of the <ElectronicId> child element. This form of setElectronicId is provided as a convenience method that is functionally equivalent to the version of setElectronicId that accepts a single ElectronicId object.

Parameters:
type - Electronic ID type.
value - Gets or sets the content value of the <ElectronicId> element
Since:
1.1

getElectronicId

public ElectronicId getElectronicId()
Gets the value of the <ElectronicId> element.

The SIF specification defines the meaning of this element as: "Electronic identifier associated with this Transaction."

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"ItemElectronicId"
SIF2.0"ElectronicId"

Returns:
An ElectronicId object
Since:
1.1

removeElectronicId

public void removeElectronicId()
Removes the ElectronicId child element previously created by calling setElectronicId

Since:
1.1

getCallNumber

public java.lang.String getCallNumber()
Gets the value of the <CallNumber> element.

The SIF specification defines the meaning of this element as: "The library call number, if any, assigned to this item."

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

setCallNumber

public void setCallNumber(java.lang.String value)
Sets the value of the <CallNumber> element.

The SIF specification defines the meaning of this element as: "The library call number, if any, assigned to this item."

Parameters:
value - A String object
Since:
1.1

getPrice

public java.math.BigDecimal getPrice()
Gets the value of the <Price> element.

The SIF specification defines the meaning of this element as: "The cost of this item. "

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"CopyPrice"
SIF2.0"Price"

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

setPrice

public void setPrice(java.math.BigDecimal value)
Sets the value of the <Price> element.

The SIF specification defines the meaning of this element as: "The cost of this item. "

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"CopyPrice"
SIF2.0"Price"

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