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

An interface for specifying the ordering of search results.

MethodorderByProgram
Description

Specifies a preference for ordering the result set by program.

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

Tests if a course order is available.

Returnboolean true if a course order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProgramSearchOrder
Description

Gets the course order.

Returnosid.course.program.ProgramSearchOrderthe program search order
ErrorsUNIMPLEMENTED supportsProgramSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsProgramSearchOrder() is true.
MethodorderByTerm
Description

Specifies a preference for ordering the result set by term.

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

Tests if a term order is available.

Returnboolean true if a term order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTermSearchOrder
Description

Gets the term order.

Returnosid.course.TermSearchOrderthe term search order
ErrorsUNIMPLEMENTED supportsTermSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsTermSearchOrder() is true.
MethodorderByTitle
Description

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

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

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

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

Specifies a preference for ordering the result set by program completion requirements.

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

Specifies a preference for ordering the result set by program offerings requiring registration.

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

Specifies a preference for ordering the result set by the minimum seats.

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

Specifies a preference for ordering the result set by the maximum seats.

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

Specifies a preference for ordering the result set by url.

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

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

Parametersosid.type.TypeprogramOfferingRecordTypea program offering record type
Returnosid.course.program.records.ProgramOfferingSearchOrderRecordthe program offering search order record
ErrorsNULL_ARGUMENT programOfferingRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(programOfferingRecordType) is false
CompliancemandatoryThis method must be implemented.