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

An interface for specifying the ordering of search results.

MethodorderByRegistration
Description

Specifies a preference for ordering the result set by registration.

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

Tests if a regiistration search order is available.

Returnboolean true if a registration search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationSearchOrder
Description

Gets the registration search order.

Returnosid.course.registration.RegistrationSearchOrderthe registration search order
ErrorsUNIMPLEMENTED supportsRegistrationSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsRegistrationSearchOrder() is true.
MethodorderByActivity
Description

Specifies a preference for ordering the result set by activity.

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

Tests if an activity search order is available.

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

Gets the activity search order.

Returnosid.course.ActivitySearchOrderthe activity search order
ErrorsUNIMPLEMENTED supportsActivitySearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsActivitySearchOrder() 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.
MethodgetActivityRegistrationSearchOrderRecord
Description

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

Parametersosid.type.TypeactivityRegistrationRecordTypean activity registration record type
Returnosid.course.registration.records.ActivityRegistrationSearchOrderRecordthe activity registration search order record
ErrorsNULL_ARGUMENT activityRegistrationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRegistrationRecordType) is false
CompliancemandatoryThis method must be implemented.