com.edustructures.sifworks.instr
Class Activity

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Activity
extends SIFDataObject

The work assigned to students, an educational event planned by a teacher to deliver a particular educational concept or skill. 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

Activity()
Constructor

Activity(java.lang.String refId, LanguageCode language, ActivityTime activityTime)
Constructor that accepts values for all mandatory fields

Method Summary

ActivityTime	getActivityTime() Gets the value of the <ActivityTime> element.
java.math.BigDecimal	getActivityWeight() Gets the value of the <ActivityWeight> element.
java.lang.String	getAssessmentRefId() Gets the value of the <AssessmentRefId> element.
EssentialMaterials	getEssentialMaterials() Gets the value of the <EssentialMaterials> element.
Evaluation	getEvaluation() Gets the value of the <Evaluation> 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.
LearningResources	getLearningResources() Gets the value of the <LearningResources> element.
LearningStandards	getLearningStandards() Gets the value of the <LearningStandards> element.
java.lang.Integer	getMaxAttemptsAllowed() Gets the value of the <MaxAttemptsAllowed> element.
java.lang.Integer	getPoints() Gets the value of the <Points> 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.
Students	getStudents() Gets the value of the <Students> element.
SubjectArea	getSubjectArea() Gets the value of the <SubjectArea> element.
TechnicalRequirements	getTechnicalRequirements() Gets the value of the <TechnicalRequirements> element.
java.lang.String	getTitle() Gets the value of the <Title> element.
void	removeActivityTime() Removes the ActivityTime child element previously created by calling setActivityTime
void	removeEssentialMaterials() Removes the EssentialMaterials child element previously created by calling setEssentialMaterials
void	removeEvaluation() Removes the Evaluation child element previously created by calling setEvaluation
void	removeLearningObjectives() Removes the LearningObjectives child element previously created by calling setLearningObjectives
void	removeLearningResources() Removes the LearningResources child element previously created by calling setLearningResources
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	removeSubjectArea() Removes the SubjectArea child element previously created by calling setSubjectArea
void	removeTechnicalRequirements() Removes the TechnicalRequirements child element previously created by calling setTechnicalRequirements
void	setActivityTime(ActivityTime value) Sets the value of the <ActivityTime> element.
void	setActivityTime(java.util.Calendar creationDate) Sets the value of the <ActivityTime> child element.
void	setActivityWeight(java.math.BigDecimal value) Sets the value of the <ActivityWeight> element.
void	setAssessmentRefId(java.lang.String value) Sets the value of the <AssessmentRefId> element.
void	setEssentialMaterials(EssentialMaterials value) Sets the value of the <EssentialMaterials> element.
void	setEvaluation(Evaluation value) Sets the value of the <Evaluation> element.
void	setEvaluation(EvaluationType evaluationType) Sets the value of the <Evaluation> child 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	setLearningResources(LearningResources value) Sets the value of the <LearningResources> 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	setPoints(java.lang.Integer value) Sets the value of the <Points> 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	setStudents(StudentPersonalRefId studentPersonalRefId) Sets the value of the <Students> child element.
void	setStudents(Students value) Sets the value of the <Students> element.
void	setSubjectArea(java.lang.String code) Sets the value of the <SubjectArea> child element.
void	setSubjectArea(SubjectArea value) Sets the value of the <SubjectArea> 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

Activity

public Activity()

Constructor

Activity

public Activity(java.lang.String refId,
                LanguageCode language,
                ActivityTime activityTime)

Constructor that accepts values for all mandatory fields

Parameters:

refId -

language -

activityTime - Time structures for the activity.

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.

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.

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

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 this activity."

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 this activity."

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 activity."

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 activity."

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 activity."

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 activity."

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 objective of the activity."

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 objective of the activity."

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 activity 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 activity 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

setSubjectArea

public void setSubjectArea(SubjectArea value)

Sets the value of the <SubjectArea> element.

The SIF specification defines the meaning of this element as: "Refer to section 5.1.30 SubjectArea."

Parameters:

value - A SubjectArea object

Since:

1.5r1

setSubjectArea

public void setSubjectArea(java.lang.String code)

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

Parameters:

code - The subject area code (i.e. the first two digits of the course classification code)

Since:

1.5r1

getSubjectArea

public SubjectArea getSubjectArea()

Gets the value of the <SubjectArea> element.

The SIF specification defines the meaning of this element as: "Refer to section 5.1.30 SubjectArea."

Returns:

A SubjectArea object

Since:

1.5r1

removeSubjectArea

public void removeSubjectArea()

Removes the SubjectArea child element previously created by calling setSubjectArea

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 activity."

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 activity."

Returns:

A Prerequisites object

Since:

1.5r1

removePrerequisites

public void removePrerequisites()

Removes the Prerequisites child element previously created by calling setPrerequisites

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: "Link to any student or group or category of students that this activity is for."

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: "Link to any student or group or category of students that this activity is for."

Returns:

A Students object

Since:

1.5r1

removeStudents

public void removeStudents()

Removes the Students child element previously created by calling setStudents

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

getPoints

public java.lang.Integer getPoints()

Gets the value of the <Points> element.

The SIF specification defines the meaning of this element as: "Number of possible points for an activity."

Returns:

The Points element of this object.

Since:

1.5r1

setPoints

public void setPoints(java.lang.Integer value)

Sets the value of the <Points> element.

The SIF specification defines the meaning of this element as: "Number of possible points for an activity."

Parameters:

value - A Integer object

Since:

1.5r1

setActivityTime

public void setActivityTime(ActivityTime value)

Sets the value of the <ActivityTime> element.

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

Parameters:

value - A ActivityTime object

Since:

1.5r1

setActivityTime

public void setActivityTime(java.util.Calendar creationDate)

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

Parameters:

creationDate - Creation date of the activity.

Since:

1.5r1

getActivityTime

public ActivityTime getActivityTime()

Gets the value of the <ActivityTime> element.

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

Returns:

An ActivityTime object

Since:

1.5r1

removeActivityTime

public void removeActivityTime()

Removes the ActivityTime child element previously created by calling setActivityTime

Since:

1.5r1

getAssessmentRefId

public java.lang.String getAssessmentRefId()

Gets the value of the <AssessmentRefId> element.

The SIF specification defines the meaning of this element as: "Link to the SIF Assessment object containing the evaluation information for this activity."

Returns:

The AssessmentRefId element of this object.

Since:

1.5r1

setAssessmentRefId

public void setAssessmentRefId(java.lang.String value)

Sets the value of the <AssessmentRefId> element.

The SIF specification defines the meaning of this element as: "Link to the SIF Assessment object containing the evaluation information for this activity."

Parameters:

value - A String object

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: "How many tries allowed."

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: "How many tries allowed."

Parameters:

value - A Integer object

Since:

1.5r1

getActivityWeight

public java.math.BigDecimal getActivityWeight()

Gets the value of the <ActivityWeight> element.

The SIF specification defines the meaning of this element as: "The percentage weight of the activity during the particular course or term."

Returns:

The ActivityWeight element of this object.

Since:

1.5r1

setActivityWeight

public void setActivityWeight(java.math.BigDecimal value)

Sets the value of the <ActivityWeight> element.

The SIF specification defines the meaning of this element as: "The percentage weight of the activity during the particular course or term."

Parameters:

value - A BigDecimal object

Since:

1.5r1

setEvaluation

public void setEvaluation(Evaluation value)

Sets the value of the <Evaluation> element.

The SIF specification defines the meaning of this element as: "Field for non-numeric types of grading and evaluation such as "narrative.""

Parameters:

value - A Evaluation object

Since:

1.5r1

setEvaluation

public void setEvaluation(EvaluationType evaluationType)

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

Parameters:

evaluationType - A qualifer for what type of evaluation this is. Valid values are "Inline" and "RefId". Inline values are contained in the optional Description element, RefIds are contained in the AssessmentRefId element.

Since:

1.5r1

getEvaluation

public Evaluation getEvaluation()

Gets the value of the <Evaluation> element.

The SIF specification defines the meaning of this element as: "Field for non-numeric types of grading and evaluation such as "narrative.""

Returns:

An Evaluation object

Since:

1.5r1

removeEvaluation

public void removeEvaluation()

Removes the Evaluation child element previously created by calling setEvaluation

Since:

1.5r1

setLearningResources

public void setLearningResources(LearningResources value)

Sets the value of the <LearningResources> element.

The SIF specification defines the meaning of this element as: "A GUID reference to a SIF LearningResource object that support this activity"

Parameters:

value - A LearningResources object

Since:

1.5r1

getLearningResources

public LearningResources getLearningResources()

Gets the value of the <LearningResources> element.

The SIF specification defines the meaning of this element as: "A GUID reference to a SIF LearningResource object that support this activity"

Returns:

A LearningResources object

Since:

1.5r1

removeLearningResources

public void removeLearningResources()

Removes the LearningResources child element previously created by calling setLearningResources

Since:

1.5r1