com.edustructures.sifworks.instr
Class ActivityTime

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.instr.ActivityTime

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ActivityTime
extends SIFKeyedElement

Time structures for the activity.

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

ActivityTime()
Constructor

ActivityTime(java.util.Calendar creationDate)
Constructor that accepts values for all mandatory fields

Method Summary

java.util.Calendar	getCreationDate() Gets the value of the <CreationDate> element.
java.util.Calendar	getDueDate() Gets the value of the <DueDate> element.
Duration	getDuration() Gets the value of the <Duration> element.
java.util.Calendar	getFinishDate() Gets the value of the <FinishDate> 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.
void	removeDuration() Removes the Duration child element previously created by calling setDuration
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	setDuration(Duration value) Sets the value of the <Duration> element.
void	setDuration(DurationUnits units, java.lang.String value) Sets the value of the <Duration> child element.
void	setFinishDate(java.util.Calendar value) Sets the value of the <FinishDate> element.
void	setStartDate(java.util.Calendar value) Sets the value of the <StartDate> 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

ActivityTime

public ActivityTime()

Constructor

ActivityTime

public ActivityTime(java.util.Calendar creationDate)

Constructor that accepts values for all mandatory fields

Parameters:

creationDate - Creation date of the activity.

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 activity."

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 activity."

Parameters:

value - A Calendar object

Since:

1.5r1

setDuration

public void setDuration(Duration value)

Sets the value of the <Duration> element.

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

Parameters:

value - A Duration object

Since:

1.5r1

setDuration

public void setDuration(DurationUnits units,
                        java.lang.String 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 Duration object.

Parameters:

units - Unit of time of the Duration value.

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

Since:

1.5r1

getDuration

public Duration getDuration()

Gets the value of the <Duration> element.

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

Returns:

A Duration 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 activity 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 activity is started."

Parameters:

value - A Calendar object

Since:

1.5r1

getFinishDate

public java.util.Calendar getFinishDate()

Gets the value of the <FinishDate> element.

The SIF specification defines the meaning of this element as: "Date activity is finished."

Returns:

The FinishDate element of this object.

Since:

1.5r1

setFinishDate

public void setFinishDate(java.util.Calendar value)

Sets the value of the <FinishDate> element.

The SIF specification defines the meaning of this element as: "Date activity is finished."

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 activity 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 activity is due."

Parameters:

value - A Calendar object

Since:

1.5r1