com.edustructures.sifworks.etranscripts
Class StudentRecordExchange

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.etranscripts.StudentRecordExchange

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StudentRecordExchange
extends SIFDataObject

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

StudentRecordExchange()
Constructor

StudentRecordExchange(java.lang.String refId)
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	getLocalId() Gets the value of the <LocalId> element.
Records	getRecords() Gets the value of the <Records> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getStateProvinceId() Gets the value of the <StateProvinceId> element.
java.lang.String	getStudentPersonalRefId() Gets the value of the <StudentPersonalRefId> element.
void	removeRecords() Removes the Records child element previously created by calling setRecords
void	setLocalId(java.lang.String value) Sets the value of the <LocalId> element.
void	setRecords(Records value) Sets the value of the <Records> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setStateProvinceId(StatePrCode value) Sets the value of the <StateProvinceId> element.
void	setStateProvinceId(java.lang.String value) Sets the value of the <StateProvinceId> element as a String.
void	setStudentPersonalRefId(java.lang.String value) Sets the value of the <StudentPersonalRefId> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

StudentRecordExchange

public StudentRecordExchange()

Constructor

StudentRecordExchange

public StudentRecordExchange(java.lang.String refId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The GUID that uniquely identifies an instance of this object.

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID that uniquely identifies an instance of this object."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

2.0

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID that uniquely identifies an instance of this object."

Parameters:

value - A String object

Since:

2.0

getStateProvinceId

public java.lang.String getStateProvinceId()

Gets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "A unique student identifier outside of SIF."

Returns:

The StateProvinceId element of this object.

Since:

2.0

setStateProvinceId

public void setStateProvinceId(StatePrCode value)

Sets the value of the <StateProvinceId> element.

The SIF specification defines the meaning of this element as: "A unique student identifier outside of SIF."

Parameters:

value - A constant defined by the StatePrCode class

Since:

2.0

setStateProvinceId

public void setStateProvinceId(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "A unique student identifier outside of SIF."

Parameters:

value - The value as a String

Since:

2.0

getLocalId

public java.lang.String getLocalId()

Gets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: "A locally-defined student identifier."

Returns:

The LocalId element of this object.

Since:

2.0

setLocalId

public void setLocalId(java.lang.String value)

Sets the value of the <LocalId> element.

The SIF specification defines the meaning of this element as: "A locally-defined student identifier."

Parameters:

value - A String object

Since:

2.0

getStudentPersonalRefId

public java.lang.String getStudentPersonalRefId()

Gets the value of the <StudentPersonalRefId> element.

The SIF specification defines the meaning of this element as: "An associated StudentPersonal object."

Returns:

The StudentPersonalRefId element of this object.

Since:

2.0

setStudentPersonalRefId

public void setStudentPersonalRefId(java.lang.String value)

Sets the value of the <StudentPersonalRefId> element.

The SIF specification defines the meaning of this element as: "An associated StudentPersonal object."

Parameters:

value - A String object

Since:

2.0

setRecords

public void setRecords(Records value)

Sets the value of the <Records> element.

Parameters:

value - A Records object

Since:

2.0

getRecords

public Records getRecords()

Gets the value of the <Records> element.

Returns:

A Records object

Since:

2.0

removeRecords

public void removeRecords()

Removes the Records child element previously created by calling setRecords

Since:

2.0