com.edustructures.sifworks.instr
Class Assignment

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.instr.Assignment

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Assignment
extends SIFDataObject

The work assigned to a student, which can comprise of learning resources, activities, and assessments. It must have a student and a time attached to it. SIF_Events are reported.

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

Assignment()
Constructor

Assignment(java.lang.String refId, LanguageCode language, AssignmentTime assignmentTime)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.Boolean	getAddToGradeBookFlag() Gets the value of the <AddToGradeBookFlag> element.
AssignmentTime	getAssignmentTime() Gets the value of the <AssignmentTime> element.
EssentialMaterials	getEssentialMaterials() Gets the value of the <EssentialMaterials> 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	getLanguage() Gets the value of the Language attribute.
LearningObjectives	getLearningObjectives() Gets the value of the <LearningObjectives> element.
LearningStandards	getLearningStandards() Gets the value of the <LearningStandards> element.
java.lang.Integer	getMaxAttemptsAllowed() Gets the value of the <MaxAttemptsAllowed> element.
java.lang.String	getPreamble() Gets the value of the <Preamble> element.
Prerequisites	getPrerequisites() Gets the value of the <Prerequisites> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
SourceObjects	getSourceObjects() Gets the value of the <SourceObjects> element.
java.lang.String	getStaffPersonalRefId() Gets the value of the <StaffPersonalRefId> element.
Students	getStudents() Gets the value of the <Students> element.
TechnicalRequirements	getTechnicalRequirements() Gets the value of the <TechnicalRequirements> element.
java.lang.String	getTitle() Gets the value of the <Title> element.
void	removeAssignmentTime() Removes the AssignmentTime child element previously created by calling setAssignmentTime
void	removeEssentialMaterials() Removes the EssentialMaterials child element previously created by calling setEssentialMaterials
void	removeLearningObjectives() Removes the LearningObjectives child element previously created by calling setLearningObjectives
void	removeLearningStandards() Removes the LearningStandards child element previously created by calling setLearningStandards
void	removePrerequisites() Removes the Prerequisites child element previously created by calling setPrerequisites
void	removeSourceObjects() Removes the SourceObjects child element previously created by calling setSourceObjects
void	removeStudents() Removes the Students child element previously created by calling setStudents
void	removeTechnicalRequirements() Removes the TechnicalRequirements child element previously created by calling setTechnicalRequirements
void	setAddToGradeBookFlag(java.lang.Boolean value) Sets the value of the <AddToGradeBookFlag> element.
void	setAssignmentTime(AssignmentTime value) Sets the value of the <AssignmentTime> element.
void	setAssignmentTime(java.util.Calendar startDate, java.util.Calendar dueDate) Sets the value of the <AssignmentTime> child element.
void	setEssentialMaterials(EssentialMaterials value) Sets the value of the <EssentialMaterials> element.
void	setLanguage(LanguageCode value) Sets the value of the Language attribute.
void	setLanguage(java.lang.String value) Sets the value of the Language attribute as a String.
void	setLearningObjectives(LearningObjectives value) Sets the value of the <LearningObjectives> element.
void	setLearningStandards(LearningStandards value) Sets the value of the <LearningStandards> element.
void	setMaxAttemptsAllowed(java.lang.Integer value) Sets the value of the <MaxAttemptsAllowed> element.
void	setPreamble(java.lang.String value) Sets the value of the <Preamble> element.
void	setPrerequisites(Prerequisites value) Sets the value of the <Prerequisites> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSourceObjects(SourceObjects value) Sets the value of the <SourceObjects> element.
void	setStaffPersonalRefId(java.lang.String value) Sets the value of the <StaffPersonalRefId> element.
void	setStudents(StudentPersonalRefId studentPersonalRefId) Sets the value of the <Students> child element.
void	setStudents(Students value) Sets the value of the <Students> element.
void	setTechnicalRequirements(TechnicalRequirements value) Sets the value of the <TechnicalRequirements> element.
void	setTitle(java.lang.String value) Sets the value of the <Title> 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

Assignment

public Assignment()

Constructor

Assignment

public Assignment(java.lang.String refId,
                  LanguageCode language,
                  AssignmentTime assignmentTime)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID assigned to assignment.

language -

assignmentTime - Time structures for the assignment.

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: "GUID assigned to assignment."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.5r1

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: "GUID assigned to assignment."

Parameters:

value - A String object

Since:

1.5r1

getLanguage

public java.lang.String getLanguage()

Gets the value of the Language attribute.

Returns:

The Language attribute of this object.

Since:

1.5r1

setLanguage

public void setLanguage(LanguageCode value)

Sets the value of the Language attribute.

Parameters:

value - A constant defined by the LanguageCode class

Since:

1.5r1

setLanguage

public void setLanguage(java.lang.String value)

Sets the value of the Language attribute as a String.

Parameters:

value - The value as a String

Since:

1.5r1

setStudents

public void setStudents(Students value)

Sets the value of the <Students> element.

The SIF specification defines the meaning of this element as: "GUID assigned to the student or students given this assignment."

Parameters:

value - A Students object

Since:

1.5r1

setStudents

public void setStudents(StudentPersonalRefId studentPersonalRefId)

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

Parameters:

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

Since:

1.5r1

getStudents

public Students getStudents()

Gets the value of the <Students> element.

The SIF specification defines the meaning of this element as: "GUID assigned to the student or students given this assignment."

Returns:

A Students object

Since:

1.5r1

removeStudents

public void removeStudents()

Removes the Students child element previously created by calling setStudents

Since:

1.5r1

getStaffPersonalRefId

public java.lang.String getStaffPersonalRefId()

Gets the value of the <StaffPersonalRefId> element.

The SIF specification defines the meaning of this element as: "GUID assigned to the educator who gave the assignment."

Returns:

The StaffPersonalRefId element of this object.

Since:

1.5r1

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: "GUID assigned to the educator who gave the assignment."

Parameters:

value - A String object

Since:

1.5r1

setTechnicalRequirements

public void setTechnicalRequirements(TechnicalRequirements value)

Sets the value of the <TechnicalRequirements> element.

The SIF specification defines the meaning of this element as: "Applications, OS, and network requirements for activity if applicable."

Parameters:

value - A TechnicalRequirements object

Since:

1.5r1

getTechnicalRequirements

public TechnicalRequirements getTechnicalRequirements()

Gets the value of the <TechnicalRequirements> element.

The SIF specification defines the meaning of this element as: "Applications, OS, and network requirements for activity if applicable."

Returns:

A TechnicalRequirements object

Since:

1.5r1

removeTechnicalRequirements

public void removeTechnicalRequirements()

Removes the TechnicalRequirements child element previously created by calling setTechnicalRequirements

Since:

1.5r1

setEssentialMaterials

public void setEssentialMaterials(EssentialMaterials value)

Sets the value of the <EssentialMaterials> element.

The SIF specification defines the meaning of this element as: "Essential materials required to engage in the assignment."

Parameters:

value - A EssentialMaterials object

Since:

1.5r1

getEssentialMaterials

public EssentialMaterials getEssentialMaterials()

Gets the value of the <EssentialMaterials> element.

The SIF specification defines the meaning of this element as: "Essential materials required to engage in the assignment."

Returns:

An EssentialMaterials object

Since:

1.5r1

removeEssentialMaterials

public void removeEssentialMaterials()

Removes the EssentialMaterials child element previously created by calling setEssentialMaterials

Since:

1.5r1

getTitle

public java.lang.String getTitle()

Gets the value of the <Title> element.

The SIF specification defines the meaning of this element as: "Descriptive name of the assignment."

Returns:

The Title element of this object.

Since:

1.5r1

setTitle

public void setTitle(java.lang.String value)

Sets the value of the <Title> element.

The SIF specification defines the meaning of this element as: "Descriptive name of the assignment."

Parameters:

value - A String object

Since:

1.5r1

getPreamble

public java.lang.String getPreamble()

Gets the value of the <Preamble> element.

The SIF specification defines the meaning of this element as: "Description and context for the assignment."

Returns:

The Preamble element of this object.

Since:

1.5r1

setPreamble

public void setPreamble(java.lang.String value)

Sets the value of the <Preamble> element.

The SIF specification defines the meaning of this element as: "Description and context for the assignment."

Parameters:

value - A String object

Since:

1.5r1

setLearningObjectives

public void setLearningObjectives(LearningObjectives value)

Sets the value of the <LearningObjectives> element.

The SIF specification defines the meaning of this element as: "Description of the educational objectives of the assignment."

Parameters:

value - A LearningObjectives object

Since:

1.5r1

getLearningObjectives

public LearningObjectives getLearningObjectives()

Gets the value of the <LearningObjectives> element.

The SIF specification defines the meaning of this element as: "Description of the educational objectives of the assignment."

Returns:

A LearningObjectives object

Since:

1.5r1

removeLearningObjectives

public void removeLearningObjectives()

Removes the LearningObjectives child element previously created by calling setLearningObjectives

Since:

1.5r1

setLearningStandards

public void setLearningStandards(LearningStandards value)

Sets the value of the <LearningStandards> element.

The SIF specification defines the meaning of this element as: "Link from assignment to associated LearningStandardItem objects."

Parameters:

value - A LearningStandards object

Since:

1.5r1

getLearningStandards

public LearningStandards getLearningStandards()

Gets the value of the <LearningStandards> element.

The SIF specification defines the meaning of this element as: "Link from assignment to associated LearningStandardItem objects."

Returns:

A LearningStandards object

Since:

1.5r1

removeLearningStandards

public void removeLearningStandards()

Removes the LearningStandards child element previously created by calling setLearningStandards

Since:

1.5r1

setPrerequisites

public void setPrerequisites(Prerequisites value)

Sets the value of the <Prerequisites> element.

The SIF specification defines the meaning of this element as: "Skills or competencies the student must have to engage in assignment."

Parameters:

value - A Prerequisites object

Since:

1.5r1

getPrerequisites

public Prerequisites getPrerequisites()

Gets the value of the <Prerequisites> element.

The SIF specification defines the meaning of this element as: "Skills or competencies the student must have to engage in assignment."

Returns:

A Prerequisites object

Since:

1.5r1

removePrerequisites

public void removePrerequisites()

Removes the Prerequisites child element previously created by calling setPrerequisites

Since:

1.5r1

setSourceObjects

public void setSourceObjects(SourceObjects value)

Sets the value of the <SourceObjects> element.

The SIF specification defines the meaning of this element as: "GUID assigned to the source object. The source object is the "thing" being assigned to a student."

Parameters:

value - A SourceObjects object

Since:

1.5r1

getSourceObjects

public SourceObjects getSourceObjects()

Gets the value of the <SourceObjects> element.

The SIF specification defines the meaning of this element as: "GUID assigned to the source object. The source object is the "thing" being assigned to a student."

Returns:

A SourceObjects object

Since:

1.5r1

removeSourceObjects

public void removeSourceObjects()

Removes the SourceObjects child element previously created by calling setSourceObjects

Since:

1.5r1

setAssignmentTime

public void setAssignmentTime(AssignmentTime value)

Sets the value of the <AssignmentTime> element.

The SIF specification defines the meaning of this element as: "Time structures for the assignment."

Parameters:

value - A AssignmentTime object

Since:

1.5r1

setAssignmentTime

public void setAssignmentTime(java.util.Calendar startDate,
                              java.util.Calendar dueDate)

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

Parameters:

startDate - Date assignment is started.

dueDate - Date assignment is due.

Since:

1.5r1

getAssignmentTime

public AssignmentTime getAssignmentTime()

Gets the value of the <AssignmentTime> element.

The SIF specification defines the meaning of this element as: "Time structures for the assignment."

Returns:

An AssignmentTime object

Since:

1.5r1

removeAssignmentTime

public void removeAssignmentTime()

Removes the AssignmentTime child element previously created by calling setAssignmentTime

Since:

1.5r1

getMaxAttemptsAllowed

public java.lang.Integer getMaxAttemptsAllowed()

Gets the value of the <MaxAttemptsAllowed> element.

The SIF specification defines the meaning of this element as: "The number attempts a student may make on this assignment. Assumed to be unlimited if omitted."

Returns:

The MaxAttemptsAllowed element of this object.

Since:

1.5r1

setMaxAttemptsAllowed

public void setMaxAttemptsAllowed(java.lang.Integer value)

Sets the value of the <MaxAttemptsAllowed> element.

The SIF specification defines the meaning of this element as: "The number attempts a student may make on this assignment. Assumed to be unlimited if omitted."

Parameters:

value - A Integer object

Since:

1.5r1

getAddToGradeBookFlag

public java.lang.Boolean getAddToGradeBookFlag()

Gets the value of the <AddToGradeBookFlag> element.

The SIF specification defines the meaning of this element as: "Flag to prompt grade book processing."

Returns:

The AddToGradeBookFlag element of this object.

Since:

1.5r1

setAddToGradeBookFlag

public void setAddToGradeBookFlag(java.lang.Boolean value)

Sets the value of the <AddToGradeBookFlag> element.

The SIF specification defines the meaning of this element as: "Flag to prompt grade book processing."

Parameters:

value - A Boolean object

Since:

1.5r1