org.osid.assessment

Interface AssessmentTakenSearchOrder

All Superinterfaces:

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

public interface AssessmentTakenSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentOfferedSearchOrder	getAssessmentOfferedSearchOrder() Gets an assessment offered search order.
AssessmentTakenSearchOrderRecord	getAssessmentTakenSearchOrderRecord(Type assessmentTakenRecordType) Gets the assessment taken search order record corresponding to the given assessment record Type.
GradeSearchOrder	getGradeSearchOrder() Gets a grade search order.
AssessmentTakenSearchOrder	getRubricSearchOrder() Gets an assessment taken search order.
GradeSystemSearchOrder	getScoreSystemSearchOrder() Gets a grade system search order.
ResourceSearchOrder	getTakerSearchOrder() Gets a resource search order.
AgentSearchOrder	getTakingAgentSearchOrder() Gets an agent search order.
void	orderByActualStartTime(SearchOrderStyle style) Specifies a preference for ordering the result set by the assessment start time.
void	orderByAssessmentOffered(SearchOrderStyle style) Specifies a preference for ordering the result set by the assessment offered.
void	orderByCompletionTime(SearchOrderStyle style) Specifies a preference for ordering the result set by the assessment deadline.
void	orderByFeedback(SearchOrderStyle style) Specifies a preference for ordering the result set by the comments.
void	orderByGrade(SearchOrderStyle style) Specifies a preference for ordering the result set by the grade.
void	orderByRubric(SearchOrderStyle style) Specifies a preference for ordering the result set by the rubric assessment.
void	orderByScore(SearchOrderStyle style) Specifies a preference for ordering the result set by the score.
void	orderByScoreSystem(SearchOrderStyle style) Specifies a preference for ordering the result set by the grade system.
void	orderByTaker(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
void	orderByTakingAgent(SearchOrderStyle style) Specifies a preference for ordering the result set by the agent.
void	orderByTimeSpent(SearchOrderStyle style) Specifies a preference for ordering the result set by the time spent.
boolean	supportsAssessmentOfferedSearchOrder() Tests if an assessment search order is available.
boolean	supportsGradeSearchOrder() Tests if a grade search order is available.
boolean	supportsRubricSearchOrder() Tests if an assessment taken search order is available.
boolean	supportsScoreSystemSearchOrder() Tests if a grade system search order is available.
boolean	supportsTakerSearchOrder() Tests if a resource search order is available.
boolean	supportsTakingAgentSearchOrder() Tests if an agent 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

orderByAssessmentOffered

void orderByAssessmentOffered(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAssessmentOfferedSearchOrder

boolean supportsAssessmentOfferedSearchOrder()

Tests if an assessment search order is available.

Returns:

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

Compliance:

mandatory - This method must be implemented.

getAssessmentOfferedSearchOrder

AssessmentOfferedSearchOrder getAssessmentOfferedSearchOrder()

Gets an assessment offered search order.

Returns:

an assessment offered search order

Throws:

UnimplementedException - supportsAssessmentOfferedSearchOrder() is false

Compliance:

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

orderByTaker

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

supportsTakerSearchOrder

boolean supportsTakerSearchOrder()

Tests if a resource search order is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTakerSearchOrder

ResourceSearchOrder getTakerSearchOrder()

Gets a resource search order.

Returns:

a resource search order

Throws:

UnimplementedException - supportsTakerSearchOrder() is false

Compliance:

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

orderByTakingAgent

void orderByTakingAgent(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTakingAgentSearchOrder

boolean supportsTakingAgentSearchOrder()

Tests if an agent search order is available.

Returns:

true if an agent search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTakingAgentSearchOrder

AgentSearchOrder getTakingAgentSearchOrder()

Gets an agent search order.

Returns:

an agent search order

Throws:

UnimplementedException - supportsTakingAgentSearchOrder() is false

Compliance:

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

orderByActualStartTime

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

orderByCompletionTime

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

orderByTimeSpent

void orderByTimeSpent(SearchOrderStyle style)

Specifies a preference for ordering the result set by the time spent.

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.

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.

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.

orderByGrade

void orderByGrade(SearchOrderStyle style)

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

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 search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeSearchOrder

GradeSearchOrder getGradeSearchOrder()

Gets a grade search order.

Returns:

a grade search order

Throws:

UnimplementedException - supportsGradeSearchOrder() is false

Compliance:

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

orderByFeedback

void orderByFeedback(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

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

Returns:

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

Compliance:

mandatory - This method must be implemented.

getRubricSearchOrder

AssessmentTakenSearchOrder getRubricSearchOrder()

Gets an assessment taken search order.

Returns:

a rubric assessment taken search order

Throws:

UnimplementedException - supportsRubricSearchOrder() is false

Compliance:

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

getAssessmentTakenSearchOrderRecord

AssessmentTakenSearchOrderRecord getAssessmentTakenSearchOrderRecord(Type assessmentTakenRecordType)
                                                                     throws OperationFailedException

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

Parameters:

assessmentTakenRecordType - an assessment record type

Returns:

the assessment taken search order record

Throws:

NullArgumentException - assessmentTakenRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentTakenRecordType) is false

Compliance:

mandatory - This method must be implemented.