com.edustructures.sifworks.datamodel
Class TimeElement

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TimeElement
extends SIFKeyedElement

This element is designed to contain the time period attached to an object. Very long periods (school year, quarter, etc.) and very small periods (second, millisecond, etc.) can be defined. This element provides a scoping description of the time metadata enclosed.

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

TimeElement()
Constructor

TimeElement(TimeElementType type, java.lang.String code, java.lang.String name, java.lang.String value)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getCode() Gets the value of the <Code> element.
java.util.Calendar	getEndDateTime() Gets the value of the <EndDateTime> element.
java.lang.Boolean	getIsCurrent() Gets the value of the <IsCurrent> 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	getName() Gets the value of the <Name> element.
SpanGaps	getSpanGaps() Gets the value of the <SpanGaps> element.
java.util.Calendar	getStartDateTime() Gets the value of the <StartDateTime> element.
java.lang.String	getType() Gets the value of the <Type> element.
java.lang.String	getValue() Gets the value of the <Value> element.
void	removeSpanGaps() Removes the SpanGaps child element previously created by calling setSpanGaps
void	setCode(java.lang.String value) Sets the value of the <Code> element.
void	setEndDateTime(java.util.Calendar value) Sets the value of the <EndDateTime> element.
void	setIsCurrent(java.lang.Boolean value) Sets the value of the <IsCurrent> element.
void	setName(java.lang.String value) Sets the value of the <Name> element.
void	setSpanGaps(SpanGaps value) Sets the value of the <SpanGaps> element.
void	setStartDateTime(java.util.Calendar value) Sets the value of the <StartDateTime> element.
void	setType(java.lang.String value) Sets the value of the <Type> element as a String.
void	setType(TimeElementType value) Sets the value of the <Type> element.
void	setValue(java.lang.String 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

TimeElement

public TimeElement()

Constructor

TimeElement

public TimeElement(TimeElementType type,
                   java.lang.String code,
                   java.lang.String name,
                   java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

type -

code - This element provides a place for the application to send structured data (code values, unique identifier, timestamps). This code value can, depending upon the use case agreement between agents, be used to qualify the data in the Value element.

name - Contains a human-readable description of the value in Value.

value - Contains the human-readable value.

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> element.

Returns:

The Type element of this object.

Since:

2.0

setType

public void setType(TimeElementType value)

Sets the value of the <Type> element.

Parameters:

value - A constant defined by the TimeElementType class

Since:

2.0

setType

public void setType(java.lang.String value)

Sets the value of the <Type> element as a String.

Parameters:

value - The value as a String

Since:

2.0

getCode

public java.lang.String getCode()

Gets the value of the <Code> element.

The SIF specification defines the meaning of this element as: "This element provides a place for the application to send structured data (code values, unique identifier, timestamps). This code value can, depending upon the use case agreement between agents, be used to qualify the data in the Value element."

Returns:

The Code element of this object.

Since:

2.0

setCode

public void setCode(java.lang.String value)

Sets the value of the <Code> element.

The SIF specification defines the meaning of this element as: "This element provides a place for the application to send structured data (code values, unique identifier, timestamps). This code value can, depending upon the use case agreement between agents, be used to qualify the data in the Value element."

Parameters:

value - A String object

Since:

2.0

getName

public java.lang.String getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Contains a human-readable description of the value in Value."

Returns:

The Name element of this object.

Since:

2.0

setName

public void setName(java.lang.String value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Contains a human-readable description of the value in Value."

Parameters:

value - A String object

Since:

2.0

getValue

public java.lang.String getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Contains the human-readable value."

Returns:

The Value element of this object.

Since:

2.0

setValue

public void setValue(java.lang.String value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Contains the human-readable value."

Parameters:

value - A String object

Since:

2.0

getStartDateTime

public java.util.Calendar getStartDateTime()

Gets the value of the <StartDateTime> element.

Returns:

The StartDateTime element of this object.

Since:

2.0

setStartDateTime

public void setStartDateTime(java.util.Calendar value)

Sets the value of the <StartDateTime> element.

Parameters:

value - A Calendar object

Since:

2.0

getEndDateTime

public java.util.Calendar getEndDateTime()

Gets the value of the <EndDateTime> element.

Returns:

The EndDateTime element of this object.

Since:

2.0

setEndDateTime

public void setEndDateTime(java.util.Calendar value)

Sets the value of the <EndDateTime> element.

Parameters:

value - A Calendar object

Since:

2.0

setSpanGaps

public void setSpanGaps(SpanGaps value)

Sets the value of the <SpanGaps> element.

Parameters:

value - A SpanGaps object

Since:

2.0

getSpanGaps

public SpanGaps getSpanGaps()

Gets the value of the <SpanGaps> element.

Returns:

A SpanGaps object

Since:

2.0

removeSpanGaps

public void removeSpanGaps()

Removes the SpanGaps child element previously created by calling setSpanGaps

Since:

2.0

getIsCurrent

public java.lang.Boolean getIsCurrent()

Gets the value of the <IsCurrent> element.

Returns:

The IsCurrent element of this object.

Since:

2.0

setIsCurrent

public void setIsCurrent(java.lang.Boolean value)

Sets the value of the <IsCurrent> element.

Parameters:

value - A Boolean object

Since:

2.0