public interface GradeEntrySearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
GradebookColumnSearchOrder |
getGradebookColumnSearchOrder()
Gets the search order for a gradebook column.
|
GradeEntrySearchOrderRecord |
getGradeEntrySearchOrderRecord(Type gradeEntryRecordType)
Gets the grade entry search order record corresponding to the given
grade entry record
Type. |
ResourceSearchOrder |
getGraderSearchOrder()
Gets the search order for a grader.
|
GradeSearchOrder |
getGradeSearchOrder()
Gets the search order for a grade.
|
AgentSearchOrder |
getGradingAgentSearchOrder()
Gets the search order for a grading agent.
|
ResourceSearchOrder |
getKeyResourceSearchOrder()
Gets the search order for a resource.
|
void |
orderByDerived(SearchOrderStyle style)
Specified a preference for ordering results by the derived entries.
|
void |
orderByGrade(SearchOrderStyle style)
Specified a preference for ordering results by the grade or score.
|
void |
orderByGradebookColumn(SearchOrderStyle style)
Specified a preference for ordering results by the gradebook column.
|
void |
orderByGrader(SearchOrderStyle style)
Specified a preference for ordering results by the grader.
|
void |
orderByGradingAgent(SearchOrderStyle style)
Specified a preference for ordering results by the grading agent.
|
void |
orderByIgnoredForCalculations(SearchOrderStyle style)
Specified a preference for ordering results by the ignore for
calculations flag.
|
void |
orderByKeyResource(SearchOrderStyle style)
Specified a preference for ordering results by the key resource.
|
void |
orderByTimeGraded(SearchOrderStyle style)
Specified a preference for ordering results by the time graded.
|
boolean |
supportsGradebookColumnSearchOrder()
Tests if a
GradebookColumnSearchOrder is available. |
boolean |
supportsGraderSearchOrder()
Tests if a
ResourceSearchOrder is available for grader
resources. |
boolean |
supportsGradeSearchOrder()
Tests if a
GradeSearchOrder is available. |
boolean |
supportsGradingAgentSearchOrder()
Tests if an
AgentSearchOrder is available fo grading
agents. |
boolean |
supportsKeyResourceSearchOrder()
Tests if a
ResourceSearchOrder is available. |
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByGradebookColumn(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsGradebookColumnSearchOrder()
GradebookColumnSearchOrder
is available. true
if a gradebook column search order is
available, false
otherwisemandatory
- This method must be implemented. GradebookColumnSearchOrder getGradebookColumnSearchOrder()
UnimplementedException
-
supportsGradebookColumnSearchOrder()
is false
optional
- This method must be implemented if
supportsGradebookColumnSearchOrder()
is
true.
void orderByKeyResource(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsKeyResourceSearchOrder()
ResourceSearchOrder
is available. true
if a key resource search order is
available, false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getKeyResourceSearchOrder()
UnimplementedException
-
supportsKeyResourceSearchOrder()
is false
optional
- This method must be implemented if
supportsKeyResourceSearchOrder()
is true.
void orderByDerived(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByIgnoredForCalculations(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()
GradeSearchOrder
is available. 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 orderByTimeGraded(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByGrader(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsGraderSearchOrder()
ResourceSearchOrder
is available for grader
resources. true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getGraderSearchOrder()
UnimplementedException
-
supportsGraderSearchOrder()
is false
optional
- This method must be implemented if
supportsGraderSearchOrder()
is true.
void orderByGradingAgent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsGradingAgentSearchOrder()
AgentSearchOrder
is available fo grading
agents. true
if an agent search order is available,
false
otherwisemandatory
- This method must be implemented. AgentSearchOrder getGradingAgentSearchOrder()
UnimplementedException
-
supportsGradingAgentSearchOrder()
is false
optional
- This method must be implemented if
supportsGradingAgentSearchOrder()
is true.
GradeEntrySearchOrderRecord getGradeEntrySearchOrderRecord(Type gradeEntryRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.gradeEntryRecordType
- a grade entry record typeNullArgumentException
- gradeEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(gradeEntryRecordType)
is false
mandatory
- This method must be implemented.