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

Tests if a course offering search order is available.

Returnboolean true if a course offering search order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetCourseOfferingSearchOrder
Description

Gets the course offering search order.

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

Specifies a preference for ordering the result set by student.

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsStudentSearchOrder
Description

Tests if a student search order is available.

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

Gets the student search order.

Returnosid.resource.ResourceSearchOrder the student search order
ErrorsUNIMPLEMENTED supportsStudentSearchOrder() is false
Complianceoptional This 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.TypecourseRegistrationRecordType a course registration record type
Returnosid.course.registration.records.CourseRegistrationSearchOrderRecord the course registration search order record
ErrorsNULL_ARGUMENT courseRegistrationRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(courseRegistrationRecordType) is false
Compliancemandatory This method must be implemented.