com.edustructures.sifworks.common
Class Students

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.common.Students

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Students
extends SIFKeyedElement

List of students

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

Students()
Constructor

Students(StudentPersonalRefId studentPersonalRefId)
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
StudentPersonalRefId	getStudentPersonalRefId() Gets the value of the <StudentPersonalRefId> element.
void	removeStudentPersonalRefId() Removes the StudentPersonalRefId child element previously created by calling setStudentPersonalRefId
void	setStudentPersonalRefId(java.lang.String value) Sets the value of the <StudentPersonalRefId> child element.
void	setStudentPersonalRefId(StudentPersonalRefId value) Sets the value of the <StudentPersonalRefId> 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

Students

public Students()

Constructor

Students

public Students(StudentPersonalRefId studentPersonalRefId)

Constructor that accepts values for all mandatory fields

Parameters:

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

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

setStudentPersonalRefId

public void setStudentPersonalRefId(StudentPersonalRefId value)

Sets the value of the <StudentPersonalRefId> element.

The SIF specification defines the meaning of this element as: "GUID that identifies the student that this element refers to."

Parameters:

value - A StudentPersonalRefId object

Since:

1.5r1

setStudentPersonalRefId

public void setStudentPersonalRefId(java.lang.String value)

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

Parameters:

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

Since:

1.5r1

getStudentPersonalRefId

public StudentPersonalRefId getStudentPersonalRefId()

Gets the value of the <StudentPersonalRefId> element.

The SIF specification defines the meaning of this element as: "GUID that identifies the student that this element refers to."

Returns:

A StudentPersonalRefId object

Since:

1.5r1

removeStudentPersonalRefId

public void removeStudentPersonalRefId()

Removes the StudentPersonalRefId child element previously created by calling setStudentPersonalRefId

Since:

1.5r1