com.edustructures.sifworks.etranscripts
Class Requirement

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.etranscripts.Requirement

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Requirement
extends SIFElement

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

Requirement()
Constructor

Requirement(java.lang.String method, PartialDateType statusDeterminationDate)
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	getMethod() Gets the value of the <Method> element.
java.lang.String	getName() Gets the value of the <Name> element.
java.lang.String	getStatus() Gets the value of the <Status> element.
PartialDateType	getStatusDeterminationDate() Gets the value of the <StatusDeterminationDate> element.
void	removeStatusDeterminationDate() Removes the StatusDeterminationDate child element previously created by calling setStatusDeterminationDate
void	setMethod(java.lang.String value) Sets the value of the <Method> element.
void	setName(java.lang.String value) Sets the value of the <Name> element.
void	setStatus(Status value) Sets the value of the <Status> element.
void	setStatus(java.lang.String value) Sets the value of the <Status> element as a String.
void	setStatusDeterminationDate(PartialDateType value) Sets the value of the <StatusDeterminationDate> element.
void	setStatusDeterminationDate(java.lang.String value) Sets the value of the <StatusDeterminationDate> child 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

Requirement

public Requirement()

Constructor

Requirement

public Requirement(java.lang.String method,
                   PartialDateType statusDeterminationDate)

Constructor that accepts values for all mandatory fields

Parameters:

method - The method by which the requirement was met.

statusDeterminationDate - Date the student's status was determined.

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

getName

public java.lang.String getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Textual description of the requirement."

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: "Textual description of the requirement."

Parameters:

value - A String object

Since:

2.0

getMethod

public java.lang.String getMethod()

Gets the value of the <Method> element.

The SIF specification defines the meaning of this element as: "The method by which the requirement was met."

Returns:

The Method element of this object.

Since:

2.0

setMethod

public void setMethod(java.lang.String value)

Sets the value of the <Method> element.

The SIF specification defines the meaning of this element as: "The method by which the requirement was met."

Parameters:

value - A String object

Since:

2.0

getStatus

public java.lang.String getStatus()

Gets the value of the <Status> element.

The SIF specification defines the meaning of this element as: "Student's status with regard to the requirement."

Returns:

The Status element of this object.

Since:

2.0

setStatus

public void setStatus(Status value)

Sets the value of the <Status> element.

The SIF specification defines the meaning of this element as: "Student's status with regard to the requirement."

Parameters:

value - A constant defined by the Status class

Since:

2.0

setStatus

public void setStatus(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Student's status with regard to the requirement."

Parameters:

value - The value as a String

Since:

2.0

setStatusDeterminationDate

public void setStatusDeterminationDate(PartialDateType value)

Sets the value of the <StatusDeterminationDate> element.

The SIF specification defines the meaning of this element as: "Date the student's status was determined."

Parameters:

value - A PartialDateType object

Since:

2.0

setStatusDeterminationDate

public void setStatusDeterminationDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getStatusDeterminationDate

public PartialDateType getStatusDeterminationDate()

Gets the value of the <StatusDeterminationDate> element.

The SIF specification defines the meaning of this element as: "Date the student's status was determined."

Returns:

A PartialDateType object

Since:

2.0

removeStatusDeterminationDate

public void removeStatusDeterminationDate()

Removes the StatusDeterminationDate child element previously created by calling setStatusDeterminationDate

Since:

2.0