OSID Logo
OSID Specifications
course registration package
Version 3.0.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.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCourseOfferingSearchOrder
Description

Tests if a course offering order is available.

Returnbooleantrue if a course offering order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseOfferingSearchOrder
Description

Gets the course offering order.

Returnosid.course.CourseOfferingSearchOrderthe course offering search order
ErrorsUNIMPLEMENTEDsupportsCourseOfferingSearchOrder() is false
ComplianceoptionalThis 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.TyperegistrationTargetRecordTypea registration target record type
Returnosid.course.registration.records.RegistrationTargetSearchOrderRecordthe registration target search order record
ErrorsNULL_ARGUMENTregistrationTargetRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(registrationTargetRecordType) is false
CompliancemandatoryThis method must be implemented.