com.edustructures.sifworks.assessment
Class AssessmentAdministration

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.assessment.AssessmentAdministration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

AssessmentAdministration()
Constructor

AssessmentAdministration(java.lang.String refId, java.lang.String assessmentFormRefId)
Constructor that accepts values for all mandatory fields

Method Summary

Address	getAddress() Gets the value of the <Address> element.
java.util.Calendar	getAdministrationDateTime() Gets the value of the <AdministrationDateTime> element.
java.lang.String	getAdministrationName() Gets the value of the <AdministrationName> element.
java.lang.String	getAssessmentFormRefId() Gets the value of the AssessmentFormRefId attribute.
java.util.Calendar	getDueDateTime() Gets the value of the <DueDateTime> element.
java.util.Calendar	getFinishDateTime() Gets the value of the <FinishDateTime> 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
java.lang.String	getLEAInfoRefId() Gets the value of the <LEAInfoRefId> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getSchoolInfoRefId() Gets the value of the <SchoolInfoRefId> element.
SpecialConditions	getSpecialConditions() Gets the value of the <SpecialConditions> element.
java.lang.String	getStaffPersonalRefId() Gets the value of the <StaffPersonalRefId> element.
java.util.Calendar	getStartDateTime() Gets the value of the <StartDateTime> element.
void	removeAddress() Removes the Address child element previously created by calling setAddress
void	removeSpecialConditions() Removes the SpecialConditions child element previously created by calling setSpecialConditions
void	setAddress(Address value) Sets the value of the <Address> element.
void	setAddress(AddressType type, Street street, java.lang.String city, StatePrCode stateProvince, CountryCode country, java.lang.String postalCode) Sets the value of the <Address> child element.
void	setAdministrationDateTime(java.util.Calendar value) Sets the value of the <AdministrationDateTime> element.
void	setAdministrationName(java.lang.String value) Sets the value of the <AdministrationName> element.
void	setAssessmentFormRefId(java.lang.String value) Sets the value of the AssessmentFormRefId attribute.
void	setDueDateTime(java.util.Calendar value) Sets the value of the <DueDateTime> element.
void	setFinishDateTime(java.util.Calendar value) Sets the value of the <FinishDateTime> element.
void	setLEAInfoRefId(java.lang.String value) Sets the value of the <LEAInfoRefId> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSchoolInfoRefId(java.lang.String value) Sets the value of the <SchoolInfoRefId> element.
void	setSpecialConditions(SpecialConditions value) Sets the value of the <SpecialConditions> element.
void	setStaffPersonalRefId(java.lang.String value) Sets the value of the <StaffPersonalRefId> element.
void	setStartDateTime(java.util.Calendar value) Sets the value of the <StartDateTime> 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

AssessmentAdministration

public AssessmentAdministration()

Constructor

AssessmentAdministration

public AssessmentAdministration(java.lang.String refId,
                                java.lang.String assessmentFormRefId)

Constructor that accepts values for all mandatory fields

Parameters:

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

assessmentFormRefId - The RefId of the assessment form used in the assessment administration.

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

Parameters:

value - A String object

Since:

2.0

getAssessmentFormRefId

public java.lang.String getAssessmentFormRefId()

Gets the value of the AssessmentFormRefId attribute.

The SIF specification defines the meaning of this attribute as: "The RefId of the assessment form used in the assessment administration."

Returns:

The AssessmentFormRefId attribute of this object.

Since:

2.0

setAssessmentFormRefId

public void setAssessmentFormRefId(java.lang.String value)

Sets the value of the AssessmentFormRefId attribute.

The SIF specification defines the meaning of this attribute as: "The RefId of the assessment form used in the assessment administration."

Parameters:

value - A String object

Since:

2.0

getAdministrationName

public java.lang.String getAdministrationName()

Gets the value of the <AdministrationName> element.

Returns:

The AdministrationName element of this object.

Since:

2.0

setAdministrationName

public void setAdministrationName(java.lang.String value)

Sets the value of the <AdministrationName> element.

Parameters:

value - A String object

Since:

2.0

setSpecialConditions

public void setSpecialConditions(SpecialConditions value)

Sets the value of the <SpecialConditions> element.

Parameters:

value - A SpecialConditions object

Since:

2.0

getSpecialConditions

public SpecialConditions getSpecialConditions()

Gets the value of the <SpecialConditions> element.

Returns:

A SpecialConditions object

Since:

2.0

removeSpecialConditions

public void removeSpecialConditions()

Removes the SpecialConditions child element previously created by calling setSpecialConditions

Since:

2.0

getAdministrationDateTime

public java.util.Calendar getAdministrationDateTime()

Gets the value of the <AdministrationDateTime> element.

The SIF specification defines the meaning of this element as: "Date and time the test is scheduled to be given."

Returns:

The AdministrationDateTime element of this object.

Since:

2.0

setAdministrationDateTime

public void setAdministrationDateTime(java.util.Calendar value)

Sets the value of the <AdministrationDateTime> element.

The SIF specification defines the meaning of this element as: "Date and time the test is scheduled to be given."

Parameters:

value - A Calendar object

Since:

2.0

getStartDateTime

public java.util.Calendar getStartDateTime()

Gets the value of the <StartDateTime> element.

The SIF specification defines the meaning of this element as: "Date and time testing begins."

Returns:

The StartDateTime element of this object.

Since:

2.0

setStartDateTime

public void setStartDateTime(java.util.Calendar value)

Sets the value of the <StartDateTime> element.

The SIF specification defines the meaning of this element as: "Date and time testing begins."

Parameters:

value - A Calendar object

Since:

2.0

getFinishDateTime

public java.util.Calendar getFinishDateTime()

Gets the value of the <FinishDateTime> element.

The SIF specification defines the meaning of this element as: "Date and time testing ends."

Returns:

The FinishDateTime element of this object.

Since:

2.0

setFinishDateTime

public void setFinishDateTime(java.util.Calendar value)

Sets the value of the <FinishDateTime> element.

The SIF specification defines the meaning of this element as: "Date and time testing ends."

Parameters:

value - A Calendar object

Since:

2.0

getDueDateTime

public java.util.Calendar getDueDateTime()

Gets the value of the <DueDateTime> element.

The SIF specification defines the meaning of this element as: "Date and time test is due."

Returns:

The DueDateTime element of this object.

Since:

2.0

setDueDateTime

public void setDueDateTime(java.util.Calendar value)

Sets the value of the <DueDateTime> element.

The SIF specification defines the meaning of this element as: "Date and time test is due."

Parameters:

value - A Calendar object

Since:

2.0

setAddress

public void setAddress(Address value)

Sets the value of the <Address> element.

The SIF specification defines the meaning of this element as: "Address of the location where the administration takes place."

Parameters:

value - A Address object

Since:

2.0

setAddress

public void setAddress(AddressType type,
                       Street street,
                       java.lang.String city,
                       StatePrCode stateProvince,
                       CountryCode country,
                       java.lang.String postalCode)

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

Parameters:

type - Code that defines the location of the address. Note: A subset of specific valid values for each instance in a data object may be listed in that object.

street - The street part of the address

city - The city part of the address.

stateProvince - The state or province code.

country - The country code.

postalCode - The ZIP/postal code.

Since:

2.0

getAddress

public Address getAddress()

Gets the value of the <Address> element.

The SIF specification defines the meaning of this element as: "Address of the location where the administration takes place."

Returns:

An Address object

Since:

2.0

removeAddress

public void removeAddress()

Removes the Address child element previously created by calling setAddress

Since:

2.0

getStaffPersonalRefId

public java.lang.String getStaffPersonalRefId()

Gets the value of the <StaffPersonalRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a staff person associated with the administration."

Returns:

The StaffPersonalRefId element of this object.

Since:

2.0

setStaffPersonalRefId

public void setStaffPersonalRefId(java.lang.String value)

Sets the value of the <StaffPersonalRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a staff person associated with the administration."

Parameters:

value - A String object

Since:

2.0

getLEAInfoRefId

public java.lang.String getLEAInfoRefId()

Gets the value of the <LEAInfoRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a school district associated with the administration."

Returns:

The LEAInfoRefId element of this object.

Since:

2.0

setLEAInfoRefId

public void setLEAInfoRefId(java.lang.String value)

Sets the value of the <LEAInfoRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a school district associated with the administration."

Parameters:

value - A String object

Since:

2.0

getSchoolInfoRefId

public java.lang.String getSchoolInfoRefId()

Gets the value of the <SchoolInfoRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a school associated with the administration."

Returns:

The SchoolInfoRefId element of this object.

Since:

2.0

setSchoolInfoRefId

public void setSchoolInfoRefId(java.lang.String value)

Sets the value of the <SchoolInfoRefId> element.

The SIF specification defines the meaning of this element as: "Optional reference to a school associated with the administration."

Parameters:

value - A String object

Since:

2.0