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

Modifier and Type	Method	Description
AssessmentSearchOrderRecord	getAssessmentSearchOrderRecord(Type assessmentRecordType)	Gets the assessment search order record corresponding to the given assessment record Type .Multiple retrievals return the same underlying object.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Method Details

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 {@code supportsLevelSearchOrder()} is {@code 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 {@code supportsRubricSearchOrder()} is {@code 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.