public interface ObjectiveSearchOrder extends OsidObjectSearchOrder, OsidFederateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AssessmentSearchOrder |
getAssessmentSearchOrder()
Gets the search order for an assessment.
|
GradeSearchOrder |
getCognitiveProcessSearchOrder()
Gets a grade search order to order on cognitive process.
|
GradeSearchOrder |
getKnowledgeCategorySearchOrder()
Gets a grade search order to order on knolwgedge category.
|
ObjectiveSearchOrderRecord |
getObjectiveSearchOrderRecord(Type objectiveRecordType)
Gets the objective search order record corresponding to the given
objective record
Type. |
void |
orderByAssessment(SearchOrderStyle style)
Specified a preference for ordering results by the assessment.
|
void |
orderByCognitiveProcess(SearchOrderStyle style)
Specifies a preference for ordering the result set by the cognitive
process.
|
void |
orderByKnowledgeCategory(SearchOrderStyle style)
Specifies a preference for ordering the result set by the knowledge
category.
|
boolean |
supportsAssessmentSearchOrder()
Tests if an
AssessmentSearchOrder is available. |
boolean |
supportsCognitiveProcessSearchOrder()
Tests if a grade search order is available.
|
boolean |
supportsKnowledgeCategorySearchOrder()
Tests if a grade search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByAssessment(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAssessmentSearchOrder()
AssessmentSearchOrder
is available. true
if an assessment search order is
available, false
otherwisemandatory
- This method must be implemented. AssessmentSearchOrder getAssessmentSearchOrder()
UnimplementedException
-
supportsAssessmentSearchOrder()
is false
optional
- This method must be implemented if
supportsAssessmentSearchOrder()
is true.
void orderByKnowledgeCategory(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsKnowledgeCategorySearchOrder()
true
if a grade search order is available,
false
otherwisemandatory
- This method must be implemented. GradeSearchOrder getKnowledgeCategorySearchOrder()
UnimplementedException
-
supportsKnowledgeCategorySearchOrder()
is false
optional
- This method must be implemented if
supportsKnowledgeCategorySearchOrder()
is
true.
void orderByCognitiveProcess(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCognitiveProcessSearchOrder()
true
if a grade search order is available,
false
otherwisemandatory
- This method must be implemented. GradeSearchOrder getCognitiveProcessSearchOrder()
UnimplementedException
-
supportsCognitiveProcessSearchOrder()
is false
optional
- This method must be implemented if
supportsCognitiveProcessSearchOrder()
is
true.
ObjectiveSearchOrderRecord getObjectiveSearchOrderRecord(Type objectiveRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.objectiveRecordType
- an objective record typeNullArgumentException
- objectiveRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(objectiveRecordType)
is false
mandatory
- This method must be implemented.