public interface AssessmentTakenSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
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.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByAssessmentOffered(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAssessmentOfferedSearchOrder()
true
if an assessment offered search order is
available, false
otherwisemandatory
- This method must be implemented. AssessmentOfferedSearchOrder getAssessmentOfferedSearchOrder()
UnimplementedException
-
supportsAssessmentOfferedSearchOrder()
is false
optional
- This method must be implemented if
supportsAssessmentOfferedSearchOrder()
is
true.
void orderByTaker(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsTakerSearchOrder()
true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getTakerSearchOrder()
UnimplementedException
-
supportsTakerSearchOrder()
is false
optional
- This method must be implemented if
supportsTakerSearchOrder()
is true.
void orderByTakingAgent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsTakingAgentSearchOrder()
true
if an agent search order is available,
false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getTakingAgentSearchOrder()
UnimplementedException
-
supportsTakingAgentSearchOrder()
is false
optional
- This method must be implemented if
supportsTakingAgentSearchOrder()
is true.
void orderByActualStartTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCompletionTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTimeSpent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByScoreSystem(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsScoreSystemSearchOrder()
true
if a grade system search order is
available, false
otherwisemandatory
- This method must be implemented. GradeSystemSearchOrder getScoreSystemSearchOrder()
UnimplementedException
-
supportsScoreSystemSearchOrder()
is false
optional
- This method must be implemented if
supportsScoreSystemSearchOrder()
is true.
void orderByScore(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByGrade(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsGradeSearchOrder()
true
if a grade search order is available,
false
otherwisemandatory
- This method must be implemented. GradeSearchOrder getGradeSearchOrder()
UnimplementedException
-
supportsGradeSearchOrder()
is false
optional
- This method must be implemented if
supportsGradeSearchOrder()
is true.
void orderByFeedback(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByRubric(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsRubricSearchOrder()
true
if an assessment taken search order is
available, false
otherwisemandatory
- This method must be implemented. AssessmentTakenSearchOrder getRubricSearchOrder()
UnimplementedException
-
supportsRubricSearchOrder()
is false
optional
- This method must be implemented if
supportsRubricSearchOrder()
is true.
AssessmentTakenSearchOrderRecord getAssessmentTakenSearchOrderRecord(Type assessmentTakenRecordType) throws OperationFailedException
Type.
Multiple retrievals
return the same underlying object.assessmentTakenRecordType
- an assessment record typeNullArgumentException
-
assessmentTakenRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(assessmentTakenRecordType)
is
false
mandatory
- This method must be implemented.