OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.CourseForm
Implementsosid.OsidObjectForm
osid.OsidOperableForm
Description

This is the form for creating and updating Courses. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CourseAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetTitleMetadata
Description

Gets the metadata for a course title.

Returnosid.Metadatametadata for the title
CompliancemandatoryThis method must be implemented.
MethodsetTitle
Description

Sets the title.

Parametersstringtitlethe new title
ErrorsINVALID_ARGUMENT title is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT title is null
CompliancemandatoryThis method must be implemented.
MethodclearTitle
Description

Removes the title.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetNumberMetadata
Description

Gets the metadata for a course number.

Returnosid.Metadatametadata for the course number
CompliancemandatoryThis method must be implemented.
MethodsetNumber
Description

Sets the course number.

Parametersstringnumberthe new course number
ErrorsINVALID_ARGUMENT number is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT number is null
CompliancemandatoryThis method must be implemented.
MethodclearNumber
Description

Removes the course number.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetSponsorsMetadata
Description

Gets the metadata for a set of sponsors.

Returnosid.Metadatametadata for the sponsors
CompliancemandatoryThis method must be implemented.
MethodsetSponsors
Description

Sets the sponsors.

Parametersosid.id.Id[]resourceIdsthe new sponsors
ErrorsINVALID_ARGUMENT resourceIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceIds is null
CompliancemandatoryThis method must be implemented.
MethodclearSponsors
Description

Removes the sponsors.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCreditsMetadata
Description

Gets the metadata for the credits.

Returnosid.Metadatametadata for the credit scale
CompliancemandatoryThis method must be implemented.
MethodsetCredits
Description

Sets the credits.

Parametersosid.id.Id[]gradeIdsthe new credit levels
ErrorsINVALID_ARGUMENT gradeIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT gradeIds is null
CompliancemandatoryThis method must be implemented.
MethodclearCredits
Description

Removes the credits.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPrerequisitesInfoMetadata
Description

Gets the metadata for a course prerequisite informational string.

Returnosid.Metadatametadata for the prerequisite information
CompliancemandatoryThis method must be implemented.
MethodsetPrerequisitesInfo
Description

Sets the prerequisitie information.

ParametersstringprereqInfothe new prerequsite information
ErrorsINVALID_ARGUMENT prereqInfo is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT prereqInfo is null
CompliancemandatoryThis method must be implemented.
MethodclearPrerequisitesInfo
Description

Removes the prerequisite information.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPrerequisitesMetadata
Description

Gets the metadata for a prerequisites.

Returnosid.Metadatametadata for the requisites
CompliancemandatoryThis method must be implemented.
MethodsetPrerequisites
Description

Sets the prerequisites.

Parametersosid.id.Id[]requisiteIdsthe new requisites
ErrorsINVALID_ARGUMENT requisiteIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT requisiteIds is null
CompliancemandatoryThis method must be implemented.
MethodclearPrerequisites
Description

Removes the prerequisites.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetLevelsMetadata
Description

Gets the metadata for a set of grade levels.

Returnosid.Metadatametadata for the levels
CompliancemandatoryThis method must be implemented.
MethodsetLevels
Description

Sets the levels.

Parametersosid.id.Id[]gradeIdsthe new grade levels
ErrorsINVALID_ARGUMENT gradeIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT gradeIds is null
CompliancemandatoryThis method must be implemented.
MethodclearLevels
Description

Removes the grade levels.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetGradingOptionsMetadata
Description

Gets the metadata for a set of grading options.

Returnosid.Metadatametadata for the grading options
CompliancemandatoryThis method must be implemented.
MethodsetGradingOptions
Description

Sets the grading options.

Parametersosid.id.Id[]gradeSystemIdsthe new grade systems
ErrorsINVALID_ARGUMENT gradeSystemIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT gradeSystemIds is null
CompliancemandatoryThis method must be implemented.
MethodclearGradingOptions
Description

Removes the grading options.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveMetadata
Description

Gets the metadata for a set of learning objectives.

Returnosid.Metadatametadata for the obecjtives
CompliancemandatoryThis method must be implemented.
MethodsetLearningObjectives
Description

Sets the learning objectives.

Parametersosid.id.Id[]objectiveIdsthe new obejctives
ErrorsINVALID_ARGUMENT objectiveIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT objectiveIds is null
CompliancemandatoryThis method must be implemented.
MethodclearLearningObjectives
Description

Removes the learning objectives.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCourseFormRecord
Description

Gets the CourseFormRecord corresponding to the given course record Type.

Parametersosid.type.TypecourseRecordTypea course record type
Returnosid.course.records.CourseFormRecordthe course form record
ErrorsNULL_ARGUMENT courseRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(courseRecordType) is false
CompliancemandatoryThis method must be implemented.