org.osid.assessment

Interface AssessmentOfferedSearchOrder

All Superinterfaces:

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

public interface AssessmentOfferedSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentOfferedSearchOrderRecord	getAssessmentOfferedSearchOrderRecord(Type assessmentOfferedRecordType) Gets the assessment offered search order record corresponding to the given assessment record Type.
AssessmentSearchOrder	getAssessmentSearchOrder() Gets an assessment search order.
GradeSystemSearchOrder	getGradeSystemSearchOrder() Gets a grade system search order.
GradeSearchOrder	getLevelSearchOrder() Gets a grade search order.
AssessmentOfferedSearchOrder	getRubricSearchOrder() Gets an assessment offered search order.
GradeSystemSearchOrder	getScoreSystemSearchOrder() Gets a grade system search order.
void	orderByAssessment(SearchOrderStyle style) Specifies a preference for ordering the result set by the assessment.
void	orderByDeadline(SearchOrderStyle style) Specifies a preference for ordering the result set by the assessment deadline.
void	orderByDuration(SearchOrderStyle style) Specifies a preference for ordering the result set by the duration.
void	orderByGradeSystem(SearchOrderStyle style) Specifies a preference for ordering the result set by the grade system for grades.
void	orderByItemsSequential(SearchOrderStyle style) Specifies a preference for ordering the result set by the sequential flag.
void	orderByItemsShuffled(SearchOrderStyle style) Specifies a preference for ordering the result set by the shuffle flag.
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 offered.
void	orderByScoreSystem(SearchOrderStyle style) Specifies a preference for ordering the result set by the grade system for scores.
void	orderByStartTime(SearchOrderStyle style) Specifies a preference for ordering the result set by the assessment start time.
boolean	supportsAssessmentSearchOrder() Tests if an assessment search order is available.
boolean	supportsGradeSystemSearchOrder() Tests if a grade system search order is available.
boolean	supportsLevelSearchOrder() Tests if a grade search order is available.
boolean	supportsRubricSearchOrder() Tests if an assessment offered search order is available.
boolean	supportsScoreSystemSearchOrder() Tests if a grade system 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

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 search order is available.

Returns:

true if an assessment search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssessmentSearchOrder

AssessmentSearchOrder getAssessmentSearchOrder()

Gets an assessment search order.

Returns:

an assessment search order

Throws:

UnimplementedException - supportsAssessmentSearchOrder() is false

Compliance:

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

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.

orderByItemsSequential

void orderByItemsSequential(SearchOrderStyle style)

Specifies a preference for ordering the result set by the sequential flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByItemsShuffled

void orderByItemsShuffled(SearchOrderStyle style)

Specifies a preference for ordering the result set by the shuffle flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByStartTime

void orderByStartTime(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDeadline

void orderByDeadline(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDuration

void orderByDuration(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByScoreSystem

void orderByScoreSystem(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.

supportsScoreSystemSearchOrder

boolean supportsScoreSystemSearchOrder()

Tests if a grade system search order is available.

Returns:

true if a grade system search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getScoreSystemSearchOrder

GradeSystemSearchOrder getScoreSystemSearchOrder()

Gets a grade system search order.

Returns:

a grade system search order

Throws:

UnimplementedException - supportsScoreSystemSearchOrder() is false

Compliance:

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

orderByGradeSystem

void orderByGradeSystem(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemSearchOrder

boolean supportsGradeSystemSearchOrder()

Tests if a grade system search order is available.

Returns:

true if a grade system search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeSystemSearchOrder

GradeSystemSearchOrder getGradeSystemSearchOrder()

Gets a grade system search order.

Returns:

a grade system search order

Throws:

UnimplementedException - supportsGradeSystemSearchOrder() is false

Compliance:

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

orderByRubric

void orderByRubric(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRubricSearchOrder

boolean supportsRubricSearchOrder()

Tests if an assessment offered search order is available.

Returns:

true if an assessment offered search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRubricSearchOrder

AssessmentOfferedSearchOrder getRubricSearchOrder()

Gets an assessment offered search order.

Returns:

a rubric assessment offered search order

Throws:

UnimplementedException - supportsRubricSearchOrder() is false

Compliance:

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

getAssessmentOfferedSearchOrderRecord

AssessmentOfferedSearchOrderRecord getAssessmentOfferedSearchOrderRecord(Type assessmentOfferedRecordType)
                                                                         throws OperationFailedException

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

Parameters:

assessmentOfferedRecordType - an assessment offered record type

Returns:

the assessment offered search order record

Throws:

NullArgumentException - assessmentOfferedRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentOfferedRecordType) is false

Compliance:

mandatory - This method must be implemented.