OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.RegistrationSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByActivityBundle
Description

Specifies a preference for ordering the result set by activity bundle.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityBundleSearchOrder
Description

Tests if an activity bundle search order is available.

Returnboolean true if an activity bundle search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetActivityBundleSearchOrder
Description

Gets the activity bundle search order.

Returnosid.course.registration.ActivityBundleSearchOrderthe activity bundle search order
ErrorsUNIMPLEMENTED supportsActivityBundleSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsActivityBundleSearchOrder() is true.
MethodorderByStudent
Description

Specifies a preference for ordering the result set by student.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodgetStudentSearchOrder
Description

Gets the student search order.

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

Specifies a preference for ordering the result set by the grading option.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsGradingOptionSearchOrder
Description

Tests if a grade system search order is available.

Returnboolean true if a grade system order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradingOptionSearchOrder
Description

Gets the grade system search order.

Returnosid.grading.GradeSystemSearchOrderthe grade system search order
ErrorsUNIMPLEMENTED supportsGradingOptionSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsGradingOptionSearchOrder() is true.
MethodgetRegistrationSearchOrderRecord
Description

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

Parametersosid.type.TyperegistrationRecordTypea registration record type
Returnosid.course.registration.records.RegistrationSearchOrderRecordthe registration search order record
ErrorsNULL_ARGUMENT registrationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(registrationRecordType) is false
CompliancemandatoryThis method must be implemented.