OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.EnrollmentSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByProgramOffering
Description

Specifies a preference for ordering the result set by program offering.

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

Tests if a program offering search order is available.

Returnboolean true if a program offering order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingSearchOrder
Description

Gets the program offering search order.

Returnosid.course.program.ProgramOfferingSearchOrderthe program offering search order
ErrorsUNIMPLEMENTED supportsProgramOfferingSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsProgramOfferingSearchOrder() 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 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.
MethodgetEnrollmentSearchOrderRecord
Description

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

Parametersosid.type.TypeenrollmentRecordTypean enrollment record type
Returnosid.course.program.records.EnrollmentSearchOrderRecordthe enrollment search order record
ErrorsNULL_ARGUMENT enrollmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(enrollmentRecordType) is false
CompliancemandatoryThis method must be implemented.