com.edustructures.sifworks.instr
Class LearningResource

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LearningResource
extends SIFDataObject

This object contains information related to learning resources that may be used in educational settings. These include textbooks, Internet content, educational software, videos and DVDs, supplemental print material, etc. 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

LearningResource()
Constructor

LearningResource(java.lang.String refId, LanguageCode language, java.lang.String name, Components components)
Constructor that accepts values for all mandatory fields

Method Summary

java.util.Calendar	getAgreementDate() Gets the value of the <AgreementDate> element.
Approvals	getApprovals() Gets the value of the <Approvals> element.
java.lang.String	getAuthor() Gets the value of the <Author> element.
Components	getComponents() Gets the value of the <Components> element.
Contacts	getContacts() Gets the value of the <Contacts> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
ResourceEvaluations	getEvaluations() Gets the value of the <Evaluations> element.
GradeLevels	getGradeLevels() Gets the value of the <GradeLevels> 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.
LearningStandards	getLearningStandards() Gets the value of the <LearningStandards> element.
ResourceLocation	getLocation() Gets the value of the <Location> element.
MediaTypes	getMediaTypes() Gets the value of the <MediaTypes> element.
java.lang.String	getName() Gets the value of the <Name> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
java.lang.String	getStatus() Gets the value of the <Status> element.
SubjectAreas	getSubjectAreas() Gets the value of the <SubjectAreas> element.
java.lang.String	getUseAgreement() Gets the value of the <UseAgreement> element.
void	removeApprovals() Removes the Approvals child element previously created by calling setApprovals
void	removeComponents() Removes the Components child element previously created by calling setComponents
void	removeContacts() Removes the Contacts child element previously created by calling setContacts
void	removeEvaluations() Removes the Evaluations child element previously created by calling setEvaluations
void	removeGradeLevels() Removes the GradeLevels child element previously created by calling setGradeLevels
void	removeLearningStandards() Removes the LearningStandards child element previously created by calling setLearningStandards
void	removeLocation() Removes the Location child element previously created by calling setLocation
void	removeMediaTypes() Removes the MediaTypes child element previously created by calling setMediaTypes
void	removeSubjectAreas() Removes the SubjectAreas child element previously created by calling setSubjectAreas
void	setAgreementDate(java.util.Calendar value) Sets the value of the <AgreementDate> element.
void	setApprovals(Approvals value) Sets the value of the <Approvals> element.
void	setAuthor(java.lang.String value) Sets the value of the <Author> element.
void	setComponents(Components value) Sets the value of the <Components> element.
void	setContacts(Contacts value) Sets the value of the <Contacts> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setEvaluations(ResourceEvaluations value) Sets the value of the <Evaluations> element.
void	setGradeLevels(GradeLevels value) Sets the value of the <GradeLevels> 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	setLearningStandards(LearningStandards value) Sets the value of the <LearningStandards> element.
void	setLocation(ReferenceType referenceType, java.lang.String value) Sets the value of the <Location> child element.
void	setLocation(ResourceLocation value) Sets the value of the <Location> element.
void	setMediaTypes(MediaTypes value) Sets the value of the <MediaTypes> element.
void	setName(java.lang.String value) Sets the value of the <Name> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setStatus(java.lang.String value) Sets the value of the <Status> element.
void	setSubjectAreas(SubjectAreas value) Sets the value of the <SubjectAreas> element.
void	setUseAgreement(java.lang.String value) Sets the value of the <UseAgreement> 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

LearningResource

public LearningResource()

Constructor

LearningResource

public LearningResource(java.lang.String refId,
                        LanguageCode language,
                        java.lang.String name,
                        Components components)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID assigned to this LearningResource.

language -

name - Name of learning resource.

components - A lesson or activity-sized portion of a resource.

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

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

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

getName

public java.lang.String getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of learning resource."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"ResourceName"
SIF2.0	"Name"

Returns:

The Name element of this object.

Since:

1.5r1

setName

public void setName(java.lang.String value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of learning resource."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"ResourceName"
SIF2.0	"Name"

Parameters:

value - A String object

Since:

1.5r1

getAuthor

public java.lang.String getAuthor()

Gets the value of the <Author> element.

The SIF specification defines the meaning of this element as: "Name of organization or company that created the resource."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"ResourceAuthor"
SIF2.0	"Author"

Returns:

The Author element of this object.

Since:

1.5r1

setAuthor

public void setAuthor(java.lang.String value)

Sets the value of the <Author> element.

The SIF specification defines the meaning of this element as: "Name of organization or company that created the resource."

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"ResourceAuthor"
SIF2.0	"Author"

Parameters:

value - A String object

Since:

1.5r1

setContacts

public void setContacts(Contacts value)

Sets the value of the <Contacts> element.

The SIF specification defines the meaning of this element as: "Contains contact information about resource authors."

Parameters:

value - A Contacts object

Since:

1.5r1

getContacts

public Contacts getContacts()

Gets the value of the <Contacts> element.

The SIF specification defines the meaning of this element as: "Contains contact information about resource authors."

Returns:

A Contacts object

Since:

1.5r1

removeContacts

public void removeContacts()

Removes the Contacts child element previously created by calling setContacts

Since:

1.5r1

setLocation

public void setLocation(ResourceLocation value)

Sets the value of the <Location> element.

The SIF specification defines the meaning of this element as: "Description of location of resource, i.e. location in library or URL, community resource, outside resource supplier."

Parameters:

value - A ResourceLocation object

Since:

1.5r1

setLocation

public void setLocation(ReferenceType referenceType,
                        java.lang.String value)

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

Parameters:

referenceType - A qualifying attribute for the ResourceLocation payload. If ReferenceType is "URI", the payload contains a web address where the resource can be found.

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

Since:

1.5r1

getLocation

public ResourceLocation getLocation()

Gets the value of the <Location> element.

The SIF specification defines the meaning of this element as: "Description of location of resource, i.e. location in library or URL, community resource, outside resource supplier."

Returns:

A ResourceLocation object

Since:

1.5r1

removeLocation

public void removeLocation()

Removes the Location child element previously created by calling setLocation

Since:

1.5r1

getStatus

public java.lang.String getStatus()

Gets the value of the <Status> element.

The SIF specification defines the meaning of this element as: "Describes availability status of resource, e.g. "checked out.""

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"ResourceStatus"
SIF2.0	"Status"

Returns:

The Status element of this object.

Since:

1.5r1

setStatus

public void setStatus(java.lang.String value)

Sets the value of the <Status> element.

The SIF specification defines the meaning of this element as: "Describes availability status of resource, e.g. "checked out.""

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"ResourceStatus"
SIF2.0	"Status"

Parameters:

value - A String object

Since:

1.5r1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Description of the resource, e.g., "This textbook is intended for grade 4 social studies students and addresses...""

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"ResourceDescription"
SIF2.0	"Description"

Returns:

The Description element of this object.

Since:

1.5r1

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Description of the resource, e.g., "This textbook is intended for grade 4 social studies students and addresses...""

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"ResourceDescription"
SIF2.0	"Description"

Parameters:

value - A String object

Since:

1.5r1

setGradeLevels

public void setGradeLevels(GradeLevels value)

Sets the value of the <GradeLevels> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.12 GradeLevels."

Parameters:

value - A GradeLevels object

Since:

1.5r1

getGradeLevels

public GradeLevels getGradeLevels()

Gets the value of the <GradeLevels> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.12 GradeLevels."

Returns:

A GradeLevels object

Since:

1.5r1

removeGradeLevels

public void removeGradeLevels()

Removes the GradeLevels child element previously created by calling setGradeLevels

Since:

1.5r1

setSubjectAreas

public void setSubjectAreas(SubjectAreas value)

Sets the value of the <SubjectAreas> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.30 SubjectArea."

Parameters:

value - A SubjectAreas object

Since:

1.5r1

getSubjectAreas

public SubjectAreas getSubjectAreas()

Gets the value of the <SubjectAreas> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.30 SubjectArea."

Returns:

A SubjectAreas object

Since:

1.5r1

removeSubjectAreas

public void removeSubjectAreas()

Removes the SubjectAreas child element previously created by calling setSubjectAreas

Since:

1.5r1

setMediaTypes

public void setMediaTypes(MediaTypes value)

Sets the value of the <MediaTypes> element.

The SIF specification defines the meaning of this element as: "MIME types [MIME] based on IANA registration (see RFC2048) or 'non-digital'."

Parameters:

value - A MediaTypes object

Since:

1.5r1

getMediaTypes

public MediaTypes getMediaTypes()

Gets the value of the <MediaTypes> element.

The SIF specification defines the meaning of this element as: "MIME types [MIME] based on IANA registration (see RFC2048) or 'non-digital'."

Returns:

A MediaTypes object

Since:

1.5r1

removeMediaTypes

public void removeMediaTypes()

Removes the MediaTypes child element previously created by calling setMediaTypes

Since:

1.5r1

getUseAgreement

public java.lang.String getUseAgreement()

Gets the value of the <UseAgreement> element.

The SIF specification defines the meaning of this element as: "Describes terms of use for resource."

Returns:

The UseAgreement element of this object.

Since:

1.5r1

setUseAgreement

public void setUseAgreement(java.lang.String value)

Sets the value of the <UseAgreement> element.

The SIF specification defines the meaning of this element as: "Describes terms of use for resource."

Parameters:

value - A String object

Since:

1.5r1

getAgreementDate

public java.util.Calendar getAgreementDate()

Gets the value of the <AgreementDate> element.

The SIF specification defines the meaning of this element as: "A date that defines the date of agreement."

Returns:

The AgreementDate element of this object.

Since:

1.5r1

setAgreementDate

public void setAgreementDate(java.util.Calendar value)

Sets the value of the <AgreementDate> element.

The SIF specification defines the meaning of this element as: "A date that defines the date of agreement."

Parameters:

value - A Calendar object

Since:

1.5r1

setApprovals

public void setApprovals(Approvals value)

Sets the value of the <Approvals> element.

The SIF specification defines the meaning of this element as: "A sub-element containing authorizations to use this resource. For example, this resource may be included as part of the district's standard curriculum model."

Parameters:

value - A Approvals object

Since:

1.5r1

getApprovals

public Approvals getApprovals()

Gets the value of the <Approvals> element.

The SIF specification defines the meaning of this element as: "A sub-element containing authorizations to use this resource. For example, this resource may be included as part of the district's standard curriculum model."

Returns:

An Approvals object

Since:

1.5r1

removeApprovals

public void removeApprovals()

Removes the Approvals child element previously created by calling setApprovals

Since:

1.5r1

setEvaluations

public void setEvaluations(ResourceEvaluations value)

Sets the value of the <Evaluations> element.

The SIF specification defines the meaning of this element as: "Evaluations/reviews of resource."

Parameters:

value - A ResourceEvaluations object

Since:

1.5r1

getEvaluations

public ResourceEvaluations getEvaluations()

Gets the value of the <Evaluations> element.

The SIF specification defines the meaning of this element as: "Evaluations/reviews of resource."

Returns:

A ResourceEvaluations object

Since:

1.5r1

removeEvaluations

public void removeEvaluations()

Removes the Evaluations child element previously created by calling setEvaluations

Since:

1.5r1

setComponents

public void setComponents(Components value)

Sets the value of the <Components> element.

The SIF specification defines the meaning of this element as: "A lesson or activity-sized portion of a resource."

Parameters:

value - A Components object

Since:

1.5r1

getComponents

public Components getComponents()

Gets the value of the <Components> element.

The SIF specification defines the meaning of this element as: "A lesson or activity-sized portion of a resource."

Returns:

A Components object

Since:

1.5r1

removeComponents

public void removeComponents()

Removes the Components child element previously created by calling setComponents

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: "Reference to a LearningStandardItem."

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: "Reference to a LearningStandardItem."

Returns:

A LearningStandards object

Since:

1.5r1

removeLearningStandards

public void removeLearningStandards()

Removes the LearningStandards child element previously created by calling setLearningStandards

Since:

1.5r1