OSID Logo
OSID Specifications
course registration request package
Version 3.0.0
Interfaceosid.course.registration.request.RegistrationRequestSearchOrder
Implementsosid.OsidRequestSearchOrder
Used Byosid.course.registration.request.RegistrationRequestItemSearchOrder
osid.course.registration.request.RegistrationRequestSearchSession
osid.course.registration.request.RegistrationRequestSmartCourseCatalogSession
Description

An interface for specifying the ordering of search results.

MethodorderByTerm
Description

Orders the results by term.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodsupportsTermSearchOrder
Description

Tests if a term search order is available.

Returnbooleantrue if a term search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTermSearchOrder
Description

Gets the term search order.

Returnosid.course.TermSearchOrderthe term search order
ErrorsILLEGAL_STATEsupportsTermSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationRequestSearchOrderRecord
Description

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

Parametersosid.type.TyperegistrationRequestRecordTypea registration request record type
Returnosid.course.registration.request.records.RegistrationRequestSearchOrderRecordthe registration request search order record
ErrorsNULL_ARGUMENTregistrationRequestRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(registrationRequestRecordType) is false
CompliancemandatoryThis method must be implemented.