OSID Logo
OSID Specifications
course registration request package
Version 3.1.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.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsTermSearchOrder
Description

Tests if a term search order is available.

Returnboolean true if a term search order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetTermSearchOrder
Description

Gets the term search order.

Returnosid.course.TermSearchOrder the term search order
ErrorsILLEGAL_STATE supportsTermSearchOrder() is false
Compliancemandatory This 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.TyperegistrationRequestRecordType a registration request record type
Returnosid.course.registration.request.records.RegistrationRequestSearchOrderRecord the registration request search order record
ErrorsNULL_ARGUMENT registrationRequestRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(registrationRequestRecordType) is false
Compliancemandatory This method must be implemented.