OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AssessmentEntrySearchOrder
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.
MethodorderByAssessment
Description

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

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

Tests if an assessment order is available.

Returnboolean true if an assessment order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentSearchOrder
Description

Gets the assessment order.

Returnosid.assessment.AssessmentSearchOrderthe assessment search order
ErrorsUNIMPLEMENTED supportsAssessmentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAssessmentSearchOrder() is true.
MethodorderByDateCompleted
Description

Specifies a preference for ordering the result set by the completion date.

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

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

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

Tests if a program order is available.

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

Gets the program order.

Returnosid.course.program.ProgramSearchOrderthe program search order
ErrorsUNIMPLEMENTED supportsProgramSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsProgramSearchOrder() 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.
MethodorderByGrade
Description

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

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.
MethodgetAssessmentEntrySearchOrderRecord
Description

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

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