OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.ProgramSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidOperableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByTitle
Description

Specifies a preference for ordering the result set by program title.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByNumber
Description

Specifies a preference for ordering the result set by program number.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCompletionRequirementsInfo
Description

Specifies a preference for ordering the result set by program completion requirements.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetProgramSearchOrderRecord
Description

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

Parametersosid.type.TypeprogramRecordTypea program record type
Returnosid.course.program.records.ProgramSearchOrderRecordthe program search order record
ErrorsNULL_ARGUMENT programRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(programRecordType) is false
CompliancemandatoryThis method must be implemented.