com.edustructures.sifworks.trans
Class TransStudents

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<TransStudent>
              com.edustructures.sifworks.trans.TransStudents

All Implemented Interfaces:

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

public class TransStudents
extends SIFList<TransStudent>

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

TransStudents()
Constructor

TransStudents(TransStudent student)
Constructor that accepts values for all mandatory fields

Method Summary

void	addStudent(java.lang.String studentPersonalRefId, StudentBoardingStatus status, java.lang.String value) Adds a new <Student> repeatable element.
TransStudent	getStudent(java.lang.String studentPersonalRefId, StudentBoardingStatus status) Gets a TransStudent object instance.
TransStudent[]	getStudents() Gets all TransStudent object instances.
void	removeStudent(java.lang.String studentPersonalRefId, StudentBoardingStatus status) Removes a TransStudent object instance.
void	setStudents(TransStudent[] students) Sets an array of TransStudent 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, getKey, 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

TransStudents

public TransStudents()

Constructor

TransStudents

public TransStudents(TransStudent student)

Constructor that accepts values for all mandatory fields

Parameters:

student -

Method Detail

addStudent

public void addStudent(java.lang.String studentPersonalRefId,
                       StudentBoardingStatus status,
                       java.lang.String value)

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

Parameters:

studentPersonalRefId - GUID that identifies the student that this element refers to.

status - Boarding status of this student

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

Since:

1.5r1

removeStudent

public void removeStudent(java.lang.String studentPersonalRefId,
                          StudentBoardingStatus status)

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

Parameters:

studentPersonalRefId - Identifies the TransStudent object to remove by its StudentPersonalRefId value

status - Identifies the TransStudent object to remove by its Status value

Since:

1.5r1

getStudent

public TransStudent getStudent(java.lang.String studentPersonalRefId,
                               StudentBoardingStatus status)

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

Parameters:

studentPersonalRefId - Identifies the TransStudent object to return by its "StudentPersonalRefId" attribute value

status - Identifies the TransStudent object to return by its "Status" attribute value

Returns:

A TransStudent object

Since:

1.5r1

getStudents

public TransStudent[] getStudents()

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

Returns:

An array of TransStudent objects

Since:

1.5r1

setStudents

public void setStudents(TransStudent[] students)

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

Since:

1.5r1