com.edustructures.sifworks.etranscripts
Class TermInfoData

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.etranscripts.TermInfoData

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TermInfoData
extends SIFKeyedElement

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

TermInfoData()
Constructor

TermInfoData(java.lang.String schoolAttendedRefId)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getDescription() Gets the value of the <Description> element.
PartialDateType	getEndDate() Gets the value of the <EndDate> 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	getSchoolAttendedRefId() Gets the value of the SchoolAttendedRefId attribute.
java.lang.Integer	getSchoolYear() Gets the value of the <SchoolYear> element.
PartialDateType	getStartDate() Gets the value of the <StartDate> element.
java.lang.String	getTermCode() Gets the value of the <TermCode> element.
TermSpan	getTermSpan() Gets the value of the <TermSpan> element.
java.lang.String	getTrack() Gets the value of the <Track> element.
void	removeEndDate() Removes the EndDate child element previously created by calling setEndDate
void	removeStartDate() Removes the StartDate child element previously created by calling setStartDate
void	removeTermSpan() Removes the TermSpan child element previously created by calling setTermSpan
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setEndDate(PartialDateType value) Sets the value of the <EndDate> element.
void	setEndDate(java.lang.String value) Sets the value of the <EndDate> child element.
void	setSchoolAttendedRefId(java.lang.String value) Sets the value of the SchoolAttendedRefId attribute.
void	setSchoolYear(java.lang.Integer value) Sets the value of the <SchoolYear> element.
void	setStartDate(PartialDateType value) Sets the value of the <StartDate> element.
void	setStartDate(java.lang.String value) Sets the value of the <StartDate> child element.
void	setTermCode(java.lang.String value) Sets the value of the <TermCode> element.
void	setTermSpan(SessionTypeCode code) Sets the value of the <TermSpan> child element.
void	setTermSpan(TermSpan value) Sets the value of the <TermSpan> element.
void	setTrack(java.lang.String value) Sets the value of the <Track> 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

TermInfoData

public TermInfoData()

Constructor

TermInfoData

public TermInfoData(java.lang.String schoolAttendedRefId)

Constructor that accepts values for all mandatory fields

Parameters:

schoolAttendedRefId - Reference to the school of record for the courses being taken (see SchoolAttended).

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

getSchoolAttendedRefId

public java.lang.String getSchoolAttendedRefId()

Gets the value of the SchoolAttendedRefId attribute.

The SIF specification defines the meaning of this attribute as: "Reference to the school of record for the courses being taken (see SchoolAttended)."

Returns:

The SchoolAttendedRefId attribute of this object.

Since:

2.0

setSchoolAttendedRefId

public void setSchoolAttendedRefId(java.lang.String value)

Sets the value of the SchoolAttendedRefId attribute.

The SIF specification defines the meaning of this attribute as: "Reference to the school of record for the courses being taken (see SchoolAttended)."

Parameters:

value - A String object

Since:

2.0

getSchoolYear

public java.lang.Integer getSchoolYear()

Gets the value of the <SchoolYear> element.

Returns:

The SchoolYear element of this object.

Since:

2.0

setSchoolYear

public void setSchoolYear(java.lang.Integer value)

Sets the value of the <SchoolYear> element.

Parameters:

value - A Integer object

Since:

2.0

setStartDate

public void setStartDate(PartialDateType value)

Sets the value of the <StartDate> element.

Parameters:

value - A PartialDateType object

Since:

2.0

setStartDate

public void setStartDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getStartDate

public PartialDateType getStartDate()

Gets the value of the <StartDate> element.

Returns:

A PartialDateType object

Since:

2.0

removeStartDate

public void removeStartDate()

Removes the StartDate child element previously created by calling setStartDate

Since:

2.0

setEndDate

public void setEndDate(PartialDateType value)

Sets the value of the <EndDate> element.

Parameters:

value - A PartialDateType object

Since:

2.0

setEndDate

public void setEndDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getEndDate

public PartialDateType getEndDate()

Gets the value of the <EndDate> element.

Returns:

A PartialDateType object

Since:

2.0

removeEndDate

public void removeEndDate()

Removes the EndDate child element previously created by calling setEndDate

Since:

2.0

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

Returns:

The Description element of this object.

Since:

2.0

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

Parameters:

value - A String object

Since:

2.0

getTermCode

public java.lang.String getTermCode()

Gets the value of the <TermCode> element.

Returns:

The TermCode element of this object.

Since:

2.0

setTermCode

public void setTermCode(java.lang.String value)

Sets the value of the <TermCode> element.

Parameters:

value - A String object

Since:

2.0

getTrack

public java.lang.String getTrack()

Gets the value of the <Track> element.

Returns:

The Track element of this object.

Since:

2.0

setTrack

public void setTrack(java.lang.String value)

Sets the value of the <Track> element.

Parameters:

value - A String object

Since:

2.0

setTermSpan

public void setTermSpan(TermSpan value)

Sets the value of the <TermSpan> element.

Parameters:

value - A TermSpan object

Since:

2.0

setTermSpan

public void setTermSpan(SessionTypeCode code)

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

Parameters:

code - Code for session type.

Since:

2.0

getTermSpan

public TermSpan getTermSpan()

Gets the value of the <TermSpan> element.

Returns:

A TermSpan object

Since:

2.0

removeTermSpan

public void removeTermSpan()

Removes the TermSpan child element previously created by calling setTermSpan

Since:

2.0