public interface AssessmentOfferedSearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
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.
|
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()
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 orderByLevel(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsLevelSearchOrder()
true
if a grade search order is available,
false
otherwisemandatory
- This method must be implemented. GradeSearchOrder getLevelSearchOrder()
UnimplementedException
-
supportsLevelSearchOrder()
is false
optional
- This method must be implemented if
supportsLevelSearchOrder()
is true.
void orderByItemsSequential(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByItemsShuffled(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByStartTime(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDeadline(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDuration(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 orderByGradeSystem(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsGradeSystemSearchOrder()
true
if a grade system search order is
available, false
otherwisemandatory
- This method must be implemented. GradeSystemSearchOrder getGradeSystemSearchOrder()
UnimplementedException
-
supportsGradeSystemSearchOrder()
is false
optional
- This method must be implemented if
supportsGradeSystemSearchOrder()
is true.
void orderByRubric(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsRubricSearchOrder()
true
if an assessment offered search order is
available, false
otherwisemandatory
- This method must be implemented. AssessmentOfferedSearchOrder getRubricSearchOrder()
UnimplementedException
-
supportsRubricSearchOrder()
is false
optional
- This method must be implemented if
supportsRubricSearchOrder()
is true.
AssessmentOfferedSearchOrderRecord getAssessmentOfferedSearchOrderRecord(Type assessmentOfferedRecordType) throws OperationFailedException
Type.
Multiple retrievals
return the same underlying object.assessmentOfferedRecordType
- an assessment offered record typeNullArgumentException
-
assessmentOfferedRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(assessmentOfferedRecordType)
is
false
mandatory
- This method must be implemented.