com.edustructures.sifworks.etranscripts
Class MarkingPeriods

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<MarkingPeriod>
              com.edustructures.sifworks.etranscripts.MarkingPeriods

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<MarkingPeriod>, java.util.Collection<MarkingPeriod>

public class MarkingPeriods
extends SIFList<MarkingPeriod>

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

MarkingPeriods()
Constructor

MarkingPeriods(MarkingPeriod markingPeriod)
Constructor that accepts values for all mandatory fields

Method Summary

void	addMarkingPeriod(GradeLevel gradeLevelWhenTaken, java.math.BigDecimal courseCreditsAttempted, java.math.BigDecimal courseCreditsEarned) Adds a new <MarkingPeriod> repeatable 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
MarkingPeriod	getMarkingPeriod(GradeLevel gradeLevelWhenTaken, java.math.BigDecimal courseCreditsAttempted, java.math.BigDecimal courseCreditsEarned) Gets a MarkingPeriod object instance.
MarkingPeriod[]	getMarkingPeriods() Gets all MarkingPeriod object instances.
void	removeMarkingPeriod(GradeLevel gradeLevelWhenTaken, java.math.BigDecimal courseCreditsAttempted, java.math.BigDecimal courseCreditsEarned) Removes a MarkingPeriod object instance.
void	setMarkingPeriods(MarkingPeriod[] markingperiods) Sets an array of MarkingPeriod objects.

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

MarkingPeriods

public MarkingPeriods()

Constructor

MarkingPeriods

public MarkingPeriods(MarkingPeriod markingPeriod)

Constructor that accepts values for all mandatory fields

Parameters:

markingPeriod -

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

addMarkingPeriod

public void addMarkingPeriod(GradeLevel gradeLevelWhenTaken,
                             java.math.BigDecimal courseCreditsAttempted,
                             java.math.BigDecimal courseCreditsEarned)

Adds a new <MarkingPeriod> repeatable element. This form of setMarkingPeriod is provided as a convenience method that is functionally equivalent to the version of setMarkingPeriod that accepts a single MarkingPeriod object.

Parameters:

gradeLevelWhenTaken - Student's grade level at time of course.

courseCreditsAttempted - Number of course credits attempted.

courseCreditsEarned - Number of course credits earned.

Since:

2.0

removeMarkingPeriod

public void removeMarkingPeriod(GradeLevel gradeLevelWhenTaken,
                                java.math.BigDecimal courseCreditsAttempted,
                                java.math.BigDecimal courseCreditsEarned)

Removes a MarkingPeriod object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

gradeLevelWhenTaken - Identifies the MarkingPeriod object to remove by its GradeLevelWhenTaken value

courseCreditsAttempted - Identifies the MarkingPeriod object to remove by its CourseCreditsAttempted value

courseCreditsEarned - Identifies the MarkingPeriod object to remove by its CourseCreditsEarned value

Since:

2.0

getMarkingPeriod

public MarkingPeriod getMarkingPeriod(GradeLevel gradeLevelWhenTaken,
                                      java.math.BigDecimal courseCreditsAttempted,
                                      java.math.BigDecimal courseCreditsEarned)

Gets a MarkingPeriod object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

gradeLevelWhenTaken - Identifies the MarkingPeriod object to return by its "GradeLevelWhenTaken" attribute value

courseCreditsAttempted - Identifies the MarkingPeriod object to return by its "CourseCreditsAttempted" attribute value

courseCreditsEarned - Identifies the MarkingPeriod object to return by its "CourseCreditsEarned" attribute value

Returns:

A MarkingPeriod object

Since:

2.0

getMarkingPeriods

public MarkingPeriod[] getMarkingPeriods()

Gets all MarkingPeriod object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of MarkingPeriod objects

Since:

2.0

setMarkingPeriods

public void setMarkingPeriods(MarkingPeriod[] markingperiods)

Sets an array of MarkingPeriod objects. All existing MarkingPeriod instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all MarkingPeriods.

Since:

2.0