com.edustructures.sifworks.programs
Class TimeUnit

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.programs.TimeUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TimeUnit
extends SIFKeyedElement

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

TimeUnit()
Constructor

TimeUnit(DurationUnit unitOfMeasure, java.math.BigDecimal value)
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	getUnitOfMeasure() Gets the value of the UnitOfMeasure attribute.
java.math.BigDecimal	getValue() Gets the value of the <Value> element.
void	setUnitOfMeasure(DurationUnit value) Sets the value of the UnitOfMeasure attribute.
void	setUnitOfMeasure(java.lang.String value) Sets the value of the UnitOfMeasure attribute as a String.
void	setValue(java.math.BigDecimal value) Sets the value of the <Value> 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

TimeUnit

public TimeUnit()

Constructor

TimeUnit

public TimeUnit(DurationUnit unitOfMeasure,
                java.math.BigDecimal value)

Constructor that accepts values for all mandatory fields

Parameters:

unitOfMeasure - Identifies unit of measure in which amount of time is expressed.

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

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

getValue

public java.math.BigDecimal getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <TimeUnit> element"

Returns:

The Value element of this object.

Since:

1.5r1

setValue

public void setValue(java.math.BigDecimal value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <TimeUnit> element"

Parameters:

value - A BigDecimal object

Since:

1.5r1

getUnitOfMeasure

public java.lang.String getUnitOfMeasure()

Gets the value of the UnitOfMeasure attribute.

The SIF specification defines the meaning of this attribute as: "Identifies unit of measure in which amount of time is expressed."

Returns:

The UnitOfMeasure attribute of this object.

Since:

1.5r1

setUnitOfMeasure

public void setUnitOfMeasure(DurationUnit value)

Sets the value of the UnitOfMeasure attribute.

The SIF specification defines the meaning of this attribute as: "Identifies unit of measure in which amount of time is expressed."

Parameters:

value - A constant defined by the DurationUnit class

Since:

1.5r1

setUnitOfMeasure

public void setUnitOfMeasure(java.lang.String value)

Sets the value of the UnitOfMeasure attribute as a String.

The SIF specification defines the meaning of this attribute as: "Identifies unit of measure in which amount of time is expressed."

Parameters:

value - The value as a String

Since:

1.5r1