com.edustructures.sifworks.etranscripts
Class StudentRecordPackage

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StudentRecordPackage
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

StudentRecordPackage()
Constructor

StudentRecordPackage(java.lang.String sifRefId, java.lang.String sifRefObject)
Constructor that accepts values for all mandatory fields

Method Summary

BinaryData	getBinaryData() Gets the value of the <BinaryData> 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
Reference	getReference() Gets the value of the <Reference> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSIF_RefId() Gets the value of the SIF_RefId attribute.
java.lang.String	getSIF_RefObject() Gets the value of the SIF_RefObject attribute.
TextData	getTextData() Gets the value of the <TextData> element.
XMLData	getXMLData() Gets the value of the <XMLData> element.
void	removeBinaryData() Removes the BinaryData child element previously created by calling setBinaryData
void	removeReference() Removes the Reference child element previously created by calling setReference
void	removeTextData() Removes the TextData child element previously created by calling setTextData
void	removeXMLData() Removes the XMLData child element previously created by calling setXMLData
void	setBinaryData(BinaryData value) Sets the value of the <BinaryData> element.
void	setBinaryData(java.lang.String value) Sets the value of the <BinaryData> child element.
void	setReference(Reference value) Sets the value of the <Reference> element.
void	setReference(java.lang.String url) Sets the value of the <Reference> child element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSIF_RefId(java.lang.String value) Sets the value of the SIF_RefId attribute.
void	setSIF_RefObject(java.lang.String value) Sets the value of the SIF_RefObject attribute.
void	setTextData(java.lang.String value) Sets the value of the <TextData> child element.
void	setTextData(TextData value) Sets the value of the <TextData> element.
void	setXMLData(java.lang.String value) Sets the value of the <XMLData> child element.
void	setXMLData(XMLData value) Sets the value of the <XMLData> 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

StudentRecordPackage

public StudentRecordPackage()

Constructor

StudentRecordPackage

public StudentRecordPackage(java.lang.String sifRefId,
                            java.lang.String sifRefObject)

Constructor that accepts values for all mandatory fields

Parameters:

sifRefId - The GUID of the customer doing the transaction.

sifRefObject - SIF customer type.

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 the package."

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 the package."

Parameters:

value - A String object

Since:

2.0

getSIF_RefId

public java.lang.String getSIF_RefId()

Gets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of the customer doing the transaction. "

Returns:

The SIF_RefId attribute of this object.

Since:

2.0

setSIF_RefId

public void setSIF_RefId(java.lang.String value)

Sets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of the customer doing the transaction. "

Parameters:

value - A String object

Since:

2.0

getSIF_RefObject

public java.lang.String getSIF_RefObject()

Gets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "SIF customer type."

Returns:

The SIF_RefObject attribute of this object.

Since:

2.0

setSIF_RefObject

public void setSIF_RefObject(java.lang.String value)

Sets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "SIF customer type."

Parameters:

value - A String object

Since:

2.0

setXMLData

public void setXMLData(XMLData value)

Sets the value of the <XMLData> element.

Parameters:

value - A XMLData object

Since:

2.0

setXMLData

public void setXMLData(java.lang.String value)

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

Parameters:

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

Since:

2.0

getXMLData

public XMLData getXMLData()

Gets the value of the <XMLData> element.

Returns:

A XMLData object

Since:

2.0

removeXMLData

public void removeXMLData()

Removes the XMLData child element previously created by calling setXMLData

Since:

2.0

setTextData

public void setTextData(TextData value)

Sets the value of the <TextData> element.

The SIF specification defines the meaning of this element as: "Contains arbitrary text, encoded in UTF-8."

Parameters:

value - A TextData object

Since:

2.0

setTextData

public void setTextData(java.lang.String value)

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

Parameters:

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

Since:

2.0

getTextData

public TextData getTextData()

Gets the value of the <TextData> element.

The SIF specification defines the meaning of this element as: "Contains arbitrary text, encoded in UTF-8."

Returns:

A TextData object

Since:

2.0

removeTextData

public void removeTextData()

Removes the TextData child element previously created by calling setTextData

Since:

2.0

setBinaryData

public void setBinaryData(BinaryData value)

Sets the value of the <BinaryData> element.

The SIF specification defines the meaning of this element as: "Contains the base64Binary encoding of binary or text data not encoded in UTF-8."

Parameters:

value - A BinaryData object

Since:

2.0

setBinaryData

public void setBinaryData(java.lang.String value)

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

Parameters:

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

Since:

2.0

getBinaryData

public BinaryData getBinaryData()

Gets the value of the <BinaryData> element.

The SIF specification defines the meaning of this element as: "Contains the base64Binary encoding of binary or text data not encoded in UTF-8."

Returns:

A BinaryData object

Since:

2.0

removeBinaryData

public void removeBinaryData()

Removes the BinaryData child element previously created by calling setBinaryData

Since:

2.0

setReference

public void setReference(Reference value)

Sets the value of the <Reference> element.

Parameters:

value - A Reference object

Since:

2.0

setReference

public void setReference(java.lang.String url)

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

Parameters:

url - Location of external content.

Since:

2.0

getReference

public Reference getReference()

Gets the value of the <Reference> element.

Returns:

A Reference object

Since:

2.0

removeReference

public void removeReference()

Removes the Reference child element previously created by calling setReference

Since:

2.0