OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CourseEntrySearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByStudent
Description

Specifies a preference for ordering the result set by the resource.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsStudentSearchOrder
Description

Tests if a resource order is available.

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

Gets the resource order.

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

Specifies a preference for ordering the result set by the course.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCourseSearchOrder
Description

Tests if a course order is available.

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

Gets the course order.

Returnosid.course.CourseSearchOrderthe course search order
ErrorsUNIMPLEMENTED supportsCourseSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCourseSearchOrder() is true.
MethodorderByTerm
Description

Specifies a preference for ordering the result set by the term.

Parametersosid.SearchOrderStylestylesearch 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.
MethodorderByComplete
Description

Specifies a preference for ordering the result set by completed courses.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCreditScale
Description

Specifies a preference for ordering the result set by the grade system for credits.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCreditScaleSearchOrder
Description

Tests if a grade system order is available.

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

Gets the grade system search order.

Returnosid.grading.GradeSystemSearchOrderthe credit scale search order
ErrorsUNIMPLEMENTED supportsCreditScaleSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCreditScaleSearchOrder() is true.
MethodorderByCreditsEarned
Description

Specifies a preference for ordering the result set by the earned credits.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByGrade
Description

Specifies a preference for ordering the result set by the grade.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsGradeSearchOrder
Description

Tests if a grade search order is available.

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

Gets the grade system search order.

Returnosid.grading.GradeSearchOrderthe grade search order
ErrorsUNIMPLEMENTED supportsGradeSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsGradeSearchOrder() is true.
MethodorderByScoreScale
Description

Specifies a preference for ordering the result set by the grade system for scores.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsScoreScaleSearchOrder
Description

Tests if a grade system order is available.

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

Gets the grade system order.

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

Specifies a preference for ordering the result set by the score.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetCourseEntrySearchOrderRecord
Description

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

Parametersosid.type.TypecourseEntryRecordTypea course entry record type
Returnosid.course.chronicle.records.CourseEntrySearchOrderRecordthe course entry search order record
ErrorsNULL_ARGUMENT courseEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(courseEntryRecordType) is false
CompliancemandatoryThis method must be implemented.