public interface SequenceRuleSearchOrder extends OsidRuleSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AssessmentPartSearchOrder |
getAssessmentPartSearchOrder()
Gets the assessment order.
|
AssessmentPartSearchOrder |
getNextAssessmentPartSearchOrder()
Gets the assessment order.
|
SequenceRuleSearchOrderRecord |
getSequenceRuleSearchOrderRecord(Type sequenceRuleRecordType)
Gets the sequence rule search order record corresponding to the given
sequence rule record
Type. |
void |
orderByAssessmentPart(SearchOrderStyle style)
Specifies a preference for ordering the result set by the assessment
part.
|
void |
orderByCumulative(SearchOrderStyle style)
Specifies a preference for ordering the result set by the cumulative.
|
void |
orderByMaximumScore(SearchOrderStyle style)
Specifies a preference for ordering the result set by the maximum
score.
|
void |
orderByMinimumScore(SearchOrderStyle style)
Specifies a preference for ordering the result set by the minimum
score.
|
void |
orderByNextAssessmentPart(SearchOrderStyle style)
Specifies a preference for ordering the result set by the assessment
part.
|
boolean |
supportsAssessmentPartSearchOrder()
Tests if an assessment part search order is available.
|
boolean |
supportsNextAssessmentPartSearchOrder()
Tests if an assessment part search order is available.
|
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByAssessmentPart(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAssessmentPartSearchOrder()
true
if an assessment part search order is
available, false
otherwisemandatory
- This method must be implemented. AssessmentPartSearchOrder getAssessmentPartSearchOrder()
UnimplementedException
-
supportsAssessmentPartSearchOrder()
is false
optional
- This method must be implemented if
supportsAssessmentPartSearchOrder()
is
true.
void orderByNextAssessmentPart(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsNextAssessmentPartSearchOrder()
true
if an assessment part search order is
available, false
otherwisemandatory
- This method must be implemented. AssessmentPartSearchOrder getNextAssessmentPartSearchOrder()
UnimplementedException
-
supportsNextAssessmentPartSearchOrder()
is
false
optional
- This method must be implemented if
supportsNextAssessmentPartSearchOrder()
is
true.
void orderByMinimumScore(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByMaximumScore(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCumulative(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. SequenceRuleSearchOrderRecord getSequenceRuleSearchOrderRecord(Type sequenceRuleRecordType) throws OperationFailedException
Type.
Multiple retrievals return
the same underlying object.sequenceRuleRecordType
- a sequence rule record typeNullArgumentException
- sequenceRuleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(sequenceRuleRecordType)
is false
mandatory
- This method must be implemented.