org.osid.course.chronicle

Interface AssessmentEntrySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface AssessmentEntrySearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentEntrySearchOrderRecord	getAssessmentEntrySearchOrderRecord(Type assessmentEntryRecordType) Gets the assessment search order record corresponding to the given assessment entry record Type.
AssessmentSearchOrder	getAssessmentSearchOrder() Gets the assessment order.
CourseSearchOrder	getCourseSearchOrder() Gets the course order.
GradeSearchOrder	getGradeSearchOrder() Gets the grade system search order.
ProgramSearchOrder	getProgramSearchOrder() Gets the program order.
GradeSystemSearchOrder	getScoreScaleSearchOrder() Gets the grade system order.
ResourceSearchOrder	getStudentSearchOrder() Gets the resource order.
void	orderByAssessment(SearchOrderStyle style) Specifies a preference for ordering the result set by the assessment.
void	orderByCourse(SearchOrderStyle style) Specifies a preference for ordering the result set by the course.
void	orderByDateCompleted(SearchOrderStyle style) Specifies a preference for ordering the result set by the completion date.
void	orderByGrade(SearchOrderStyle style) Specifies a preference for ordering the result set by the grade system for GPAs.
void	orderByProgram(SearchOrderStyle style) Specifies a preference for ordering the result set by the program.
void	orderByScore(SearchOrderStyle style) Specifies a preference for ordering the result set by the score.
void	orderByScoreScale(SearchOrderStyle style) Specifies a preference for ordering the result set by the grade system for scores.
void	orderByStudent(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
boolean	supportsAssessmentSearchOrder() Tests if an assessment order is available.
boolean	supportsCourseSearchOrder() Tests if a course order is available.
boolean	supportsGradeSearchOrder() Tests if a grade search order is available.
boolean	supportsProgramSearchOrder() Tests if a program order is available.
boolean	supportsScoreScaleSearchOrder() Tests if a grade system order is available.
boolean	supportsStudentSearchOrder() Tests if a resource order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByStudent

void orderByStudent(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsStudentSearchOrder

boolean supportsStudentSearchOrder()

Tests if a resource order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStudentSearchOrder

ResourceSearchOrder getStudentSearchOrder()

Gets the resource order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsStudentSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsStudentSearchOrder() is true.

orderByAssessment

void orderByAssessment(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAssessmentSearchOrder

boolean supportsAssessmentSearchOrder()

Tests if an assessment order is available.

Returns:

true if an assessment order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssessmentSearchOrder

AssessmentSearchOrder getAssessmentSearchOrder()

Gets the assessment order.

Returns:

the assessment search order

Throws:

UnimplementedException - supportsAssessmentSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsAssessmentSearchOrder() is true.

orderByDateCompleted

void orderByDateCompleted(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByProgram

void orderByProgram(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProgramSearchOrder

boolean supportsProgramSearchOrder()

Tests if a program order is available.

Returns:

true if a program order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramSearchOrder

ProgramSearchOrder getProgramSearchOrder()

Gets the program order.

Returns:

the program search order

Throws:

UnimplementedException - supportsProgramSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsProgramSearchOrder() is true.

orderByCourse

void orderByCourse(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCourseSearchOrder

boolean supportsCourseSearchOrder()

Tests if a course order is available.

Returns:

true if a course order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseSearchOrder

CourseSearchOrder getCourseSearchOrder()

Gets the course order.

Returns:

the course search order

Throws:

UnimplementedException - supportsCourseSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsCourseSearchOrder() is true.

orderByGrade

void orderByGrade(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsGradeSearchOrder

boolean supportsGradeSearchOrder()

Tests if a grade search order is available.

Returns:

true if a grade order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeSearchOrder

GradeSearchOrder getGradeSearchOrder()

Gets the grade system search order.

Returns:

the grade search order

Throws:

UnimplementedException - supportsGradeSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsGradeSearchOrder() is true.

orderByScoreScale

void orderByScoreScale(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsScoreScaleSearchOrder

boolean supportsScoreScaleSearchOrder()

Tests if a grade system order is available.

Returns:

true if a grade system order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getScoreScaleSearchOrder

GradeSystemSearchOrder getScoreScaleSearchOrder()

Gets the grade system order.

Returns:

the grade system search order

Throws:

UnimplementedException - supportsScoreScaleSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsScoreScaleSearchOrder() is true.

orderByScore

void orderByScore(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getAssessmentEntrySearchOrderRecord

AssessmentEntrySearchOrderRecord getAssessmentEntrySearchOrderRecord(Type assessmentEntryRecordType)
                                                                     throws OperationFailedException

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

Parameters:

assessmentEntryRecordType - an assessment entry record type

Returns:

the assessment entry search order record

Throws:

NullArgumentException - assessmentEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.