OSID Logo
OSID Specifications
course syllabus package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.DocetSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByModule
Description

Specified a preference for ordering results by the module.

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

Tests if a ModuleSearchOrder is available.

Returnboolean true if a module search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetModuleSearchOrder
Description

Gets the search order for a module.

Returnosid.course.syllabus.ModuleSearchOrderthe module search order
ErrorsUNIMPLEMENTED supportsModuleSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsModuleSearchOrder() is true.
MethodorderByActivityUnit
Description

Specified a preference for ordering results by the activity unit.

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

Tests if an ActivityUnitSearchOrder is available.

Returnboolean true if an activity unit search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitSearchOrder
Description

Gets the search order for an actvity unit.

Returnosid.course.ActivityUnitSearchOrderthe activity unit search order
ErrorsUNIMPLEMENTED supportsActivityUnitSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsActivityUnitSearchOrder() is true.
MethodorderByInClass
Description

Specified a preference for ordering results by the in class flag.

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

Specified a preference for ordering results by the duration.

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

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

Parametersosid.type.TypedocetRecordTypea docet record type
Returnosid.course.syllabus.records.DocetSearchOrderRecordthe docet search order record
ErrorsNULL_ARGUMENT docetRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(docetRecordType) is false
CompliancemandatoryThis method must be implemented.