OSID Logo
OSID Specifications
course registration package
Version 3.1.0
Interfaceosid.course.registration.RegistrationTargetSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
Used Byosid.course.registration.RegistrationSearchOrder
osid.course.registration.RegistrationTargetSearchSession
osid.course.registration.RegistrationTargetSmartCourseCatalogSession
Description

An interface for specifying the ordering of search results.

MethodorderByCourseOffering
Description

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

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetCourseOfferingSearchOrder
Description

Gets the course offering order.

Returnosid.course.CourseOfferingSearchOrder the course offering search order
ErrorsUNIMPLEMENTED supportsCourseOfferingSearchOrder() is false
Complianceoptional This method must be implemented if supportsCourseSearchOrder() is true.
MethodgetRegistrationTargetSearchOrderRecord
Description

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

Parametersosid.type.TyperegistrationTargetRecordType a registration target record type
Returnosid.course.registration.records.RegistrationTargetSearchOrderRecord the registration target search order record
ErrorsNULL_ARGUMENT registrationTargetRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(registrationTargetRecordType) is false
Compliancemandatory This method must be implemented.