com.edustructures.sifworks.datamodel
Class FeeForUse

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.datamodel.FeeForUse

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FeeForUse
extends SIFKeyedElement

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

FeeForUse()
Constructor

FeeForUse(java.lang.String meteringType)
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.lang.String	getMeteringType() Gets the value of the <MeteringType> element.
java.lang.String	getMeteringURL() Gets the value of the <MeteringURL> element.
MonetaryAmountType	getPerUseCharge() Gets the value of the <PerUseCharge> element.
java.lang.String	getUseType() Gets the value of the <UseType> element.
void	removePerUseCharge() Removes the PerUseCharge child element previously created by calling setPerUseCharge
void	setMeteringType(java.lang.String value) Sets the value of the <MeteringType> element.
void	setMeteringURL(java.lang.String value) Sets the value of the <MeteringURL> element.
void	setPerUseCharge(MonetaryAmountType value) Sets the value of the <PerUseCharge> element.
void	setPerUseCharge(java.lang.String value) Sets the value of the <PerUseCharge> child element.
void	setUseType(java.lang.String value) Sets the value of the <UseType> 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

FeeForUse

public FeeForUse()

Constructor

FeeForUse

public FeeForUse(java.lang.String meteringType)

Constructor that accepts values for all mandatory fields

Parameters:

meteringType -

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

getUseType

public java.lang.String getUseType()

Gets the value of the <UseType> element.

The SIF specification defines the meaning of this element as: "A description of the fee structure for this resource. Some resources may be licensed differently depending upon their context. For example, a content provider might charge one fee structure for resources used in the classroom and a separate fee for those resources available to parents from home."

Returns:

The UseType element of this object.

Since:

2.0

setUseType

public void setUseType(java.lang.String value)

Sets the value of the <UseType> element.

The SIF specification defines the meaning of this element as: "A description of the fee structure for this resource. Some resources may be licensed differently depending upon their context. For example, a content provider might charge one fee structure for resources used in the classroom and a separate fee for those resources available to parents from home."

Parameters:

value - A String object

Since:

2.0

getMeteringType

public java.lang.String getMeteringType()

Gets the value of the <MeteringType> element.

Returns:

The MeteringType element of this object.

Since:

2.0

setMeteringType

public void setMeteringType(java.lang.String value)

Sets the value of the <MeteringType> element.

Parameters:

value - A String object

Since:

2.0

getMeteringURL

public java.lang.String getMeteringURL()

Gets the value of the <MeteringURL> element.

Returns:

The MeteringURL element of this object.

Since:

2.0

setMeteringURL

public void setMeteringURL(java.lang.String value)

Sets the value of the <MeteringURL> element.

Parameters:

value - A String object

Since:

2.0

setPerUseCharge

public void setPerUseCharge(MonetaryAmountType value)

Sets the value of the <PerUseCharge> element.

Parameters:

value - A MonetaryAmountType object

Since:

2.0

setPerUseCharge

public void setPerUseCharge(java.lang.String value)

Sets the value of the <PerUseCharge> child element. This form of setPerUseCharge is provided as a convenience method that is functionally equivalent to the version of setPerUseCharge that accepts a single MonetaryAmountType object.

Parameters:

value - Gets or sets the content value of the <MonetaryAmountType> element

Since:

2.0

getPerUseCharge

public MonetaryAmountType getPerUseCharge()

Gets the value of the <PerUseCharge> element.

Returns:

A MonetaryAmountType object

Since:

2.0

removePerUseCharge

public void removePerUseCharge()

Removes the PerUseCharge child element previously created by calling setPerUseCharge

Since:

2.0