OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.PlanSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderBySyllabus
Description

Specifies a preference for ordering the result set by the syllabus.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsSyllabusSearchOrder
Description

Tests if a syllabus order is available.

Returnboolean true if a syllabus order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSyllabusSearchOrder
Description

Gets the syllabus order.

Returnosid.course.syllabus.SyllabusSearchOrderthe syllabus search order
ErrorsUNIMPLEMENTED supportsSyllabusSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCourseSearchOrder() is true.
MethodorderByCourseOffering
Description

Specifies a preference for ordering the result set by the course offering.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCourseOfferingSearchOrder
Description

Tests if a course offering order is available.

Returnboolean true if a course offering order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseOfferingSearchOrder
Description

Gets the course offering order.

Returnosid.course.CourseOfferingSearchOrderthe course offering search order
ErrorsUNIMPLEMENTED supportsCourseOfferingSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCourseSearchOrder() is true.
MethodgetPlanSearchOrderRecord
Description

Gets the plan search order record corresponding to the given plan record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeplanRecordTypea plan record type
Returnosid.course.plan.records.PlanSearchOrderRecordthe plan search order record
ErrorsNULL_ARGUMENT planRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(planRecordType) is false
CompliancemandatoryThis method must be implemented.