org.osid.assessment

Interface AssessmentSearchOrder

All Superinterfaces:

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

public interface AssessmentSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentSearchOrderRecord	getAssessmentSearchOrderRecord(Type assessmentRecordType) Gets the assessment search order record corresponding to the given assessment record Type.
GradeSearchOrder	getLevelSearchOrder() Gets a grade search order.
AssessmentSearchOrder	getRubricSearchOrder() Gets an assessment search order.
void	orderByLevel(SearchOrderStyle style) Specifies a preference for ordering the result set by the level of difficulty.
void	orderByRubric(SearchOrderStyle style) Specifies a preference for ordering the result set by the rubric assessment.
boolean	supportsLevelSearchOrder() Tests if a grade search order is available.
boolean	supportsRubricSearchOrder() Tests if an assessment search order is available.

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

Method Detail

orderByLevel

void orderByLevel(SearchOrderStyle style)

Specifies a preference for ordering the result set by the level of difficulty.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsLevelSearchOrder

boolean supportsLevelSearchOrder()

Tests if a grade search order is available.

Returns:

true if a grade search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLevelSearchOrder

GradeSearchOrder getLevelSearchOrder()

Gets a grade search order.

Returns:

a grade search order

Throws:

UnimplementedException - supportsLevelSearchOrder() is false

Compliance:

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

orderByRubric

void orderByRubric(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRubricSearchOrder

boolean supportsRubricSearchOrder()

Tests if an assessment search order is available.

Returns:

true if an assessment search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRubricSearchOrder

AssessmentSearchOrder getRubricSearchOrder()

Gets an assessment search order.

Returns:

a rubric assessment search order

Throws:

UnimplementedException - supportsRubricSearchOrder() is false

Compliance:

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

getAssessmentSearchOrderRecord

AssessmentSearchOrderRecord getAssessmentSearchOrderRecord(Type assessmentRecordType)
                                                           throws OperationFailedException

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

Parameters:

assessmentRecordType - an assessment record type

Returns:

the assessment search order record

Throws:

NullArgumentException - assessmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentRecordType) is false

Compliance:

mandatory - This method must be implemented.