com.edustructures.sifworks.instr
Class AssignmentTime

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.instr.AssignmentTime

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AssignmentTime
extends SIFElement

Time structures for the assignment.

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

AssignmentTime()
Constructor

AssignmentTime(java.util.Calendar startDate, java.util.Calendar dueDate)
Constructor that accepts values for all mandatory fields

Method Summary

java.util.Calendar	getAdministrationDate() Gets the value of the <AdministrationDate> element.
java.util.Calendar	getCreationDate() Gets the value of the <CreationDate> element.
java.util.Calendar	getDueDate() Gets the value of the <DueDate> element.
java.util.Calendar	getDueTime() Gets the value of the <DueTime> element.
TimeDuration	getDuration() Gets the value of the <Duration> 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.util.Calendar	getStartDate() Gets the value of the <StartDate> element.
java.util.Calendar	getStartTime() Gets the value of the <StartTime> element.
void	removeDuration() Removes the Duration child element previously created by calling setDuration
void	setAdministrationDate(java.util.Calendar value) Sets the value of the <AdministrationDate> element.
void	setCreationDate(java.util.Calendar value) Sets the value of the <CreationDate> element.
void	setDueDate(java.util.Calendar value) Sets the value of the <DueDate> element.
void	setDueTime(java.util.Calendar value) Sets the value of the <DueTime> element.
void	setDuration(TimeDuration value) Sets the value of the <Duration> element.
void	setDuration(TimeUnits units, java.math.BigDecimal value) Sets the value of the <Duration> child element.
void	setStartDate(java.util.Calendar value) Sets the value of the <StartDate> element.
void	setStartTime(java.util.Calendar value) Sets the value of the <StartTime> 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

AssignmentTime

public AssignmentTime()

Constructor

AssignmentTime

public AssignmentTime(java.util.Calendar startDate,
                      java.util.Calendar dueDate)

Constructor that accepts values for all mandatory fields

Parameters:

startDate - Date assignment is started.

dueDate - Date assignment is due.

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

getCreationDate

public java.util.Calendar getCreationDate()

Gets the value of the <CreationDate> element.

The SIF specification defines the meaning of this element as: "Creation date of the assignment"

Returns:

The CreationDate element of this object.

Since:

1.5r1

setCreationDate

public void setCreationDate(java.util.Calendar value)

Sets the value of the <CreationDate> element.

The SIF specification defines the meaning of this element as: "Creation date of the assignment"

Parameters:

value - A Calendar object

Since:

1.5r1

setDuration

public void setDuration(TimeDuration value)

Sets the value of the <Duration> element.

The SIF specification defines the meaning of this element as: "Time required to complete the assignment."

Parameters:

value - A TimeDuration object

Since:

1.5r1

setDuration

public void setDuration(TimeUnits units,
                        java.math.BigDecimal value)

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

Parameters:

units -

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

Since:

1.5r1

getDuration

public TimeDuration getDuration()

Gets the value of the <Duration> element.

The SIF specification defines the meaning of this element as: "Time required to complete the assignment."

Returns:

A TimeDuration object

Since:

1.5r1

removeDuration

public void removeDuration()

Removes the Duration child element previously created by calling setDuration

Since:

1.5r1

getStartDate

public java.util.Calendar getStartDate()

Gets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "Date assignment is started."

Returns:

The StartDate element of this object.

Since:

1.5r1

setStartDate

public void setStartDate(java.util.Calendar value)

Sets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "Date assignment is started."

Parameters:

value - A Calendar object

Since:

1.5r1

getStartTime

public java.util.Calendar getStartTime()

Gets the value of the <StartTime> element.

The SIF specification defines the meaning of this element as: "Time assignment is started."

Returns:

The StartTime element of this object.

Since:

1.5r1

setStartTime

public void setStartTime(java.util.Calendar value)

Sets the value of the <StartTime> element.

The SIF specification defines the meaning of this element as: "Time assignment is started."

Parameters:

value - A Calendar object

Since:

1.5r1

getDueDate

public java.util.Calendar getDueDate()

Gets the value of the <DueDate> element.

The SIF specification defines the meaning of this element as: "Date assignment is due."

Returns:

The DueDate element of this object.

Since:

1.5r1

setDueDate

public void setDueDate(java.util.Calendar value)

Sets the value of the <DueDate> element.

The SIF specification defines the meaning of this element as: "Date assignment is due."

Parameters:

value - A Calendar object

Since:

1.5r1

getDueTime

public java.util.Calendar getDueTime()

Gets the value of the <DueTime> element.

The SIF specification defines the meaning of this element as: "Time assignment is due."

Returns:

The DueTime element of this object.

Since:

1.5r1

setDueTime

public void setDueTime(java.util.Calendar value)

Sets the value of the <DueTime> element.

The SIF specification defines the meaning of this element as: "Time assignment is due."

Parameters:

value - A Calendar object

Since:

1.5r1

getAdministrationDate

public java.util.Calendar getAdministrationDate()

Gets the value of the <AdministrationDate> element.

The SIF specification defines the meaning of this element as: "Date that the assignment was administered to student if an assessment."

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.

Version	Tag
1.5r1	"AdminDate"
SIF2.0	"AdministrationDate"

Returns:

The AdministrationDate element of this object.

Since:

1.5r1

setAdministrationDate

public void setAdministrationDate(java.util.Calendar value)

Sets the value of the <AdministrationDate> element.

The SIF specification defines the meaning of this element as: "Date that the assignment was administered to student if an assessment."

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.

Version	Tag
1.5r1	"AdminDate"
SIF2.0	"AdministrationDate"

Parameters:

value - A Calendar object

Since:

1.5r1