OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Interfaceosid.course.registration.CourseRegistrationSearchOrder
Implementsosid.OsidRelationshipSearchOrder
osid.OsidSubjugateableSearchOrder
Used Byosid.course.registration.ActivityRegistrationSearchOrder
osid.course.registration.CourseRegistrationSearchSession
osid.course.registration.CourseRegistrationSmartCourseCatalogSession
osid.course.registration.RegistrationSearchOrder
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 search order is available.

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

Gets the course offering search order.

Returnosid.course.CourseOfferingSearchOrderthe course offering search order
ErrorsUNIMPLEMENTEDsupportsCourseOfferingSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCourseOfferingSearchOrder() is true .
MethodorderByStudent
Description

Specifies a preference for ordering the result set by student.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodsupportsStudentSearchOrder
Description

Tests if a student search order is available.

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

Gets the student search order.

Returnosid.resource.ResourceSearchOrderthe student search order
ErrorsUNIMPLEMENTEDsupportsStudentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsStudentSearchOrder() is true .
MethodgetCourseRegistrationSearchOrderRecord
Description

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

Parametersosid.type.TypecourseRegistrationRecordTypea course registration record type
Returnosid.course.registration.records.CourseRegistrationSearchOrderRecordthe course registration search order record
ErrorsNULL_ARGUMENTcourseRegistrationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(courseRegistrationRecordType) is false
CompliancemandatoryThis method must be implemented.