public interface InquirySearchOrder extends OsidRuleSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AuditSearchOrder |
getAuditSearchOrder()
Gets the audit search order.
|
InquirySearchOrderRecord |
getInquirySearchOrderRecord(Type inquiryRecordType)
Gets the inquiry search order record corresponding to the given
inquiry record
Type. |
void |
orderByAffirmationRequired(SearchOrderStyle style)
Orders the results by the affirmation required flag.
|
void |
orderByAudit(SearchOrderStyle style)
Orders the results by the audit.
|
void |
orderByNeedsOneResponse(SearchOrderStyle style)
Orders the results by the needs one response flag.
|
void |
orderByQuestion(SearchOrderStyle style)
Orders the results by the question.
|
void |
orderByRequired(SearchOrderStyle style)
Orders the results by the required flag.
|
boolean |
supportsAuditSearchOrder()
Tests if an audit search order is available.
|
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByAudit(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAuditSearchOrder()
true
if an audit search order is available,
false
otherwisemandatory
- This method must be implemented. AuditSearchOrder getAuditSearchOrder()
IllegalStateException
-
supportsAuditSearchOrder()
is false
mandatory
- This method must be implemented. void orderByQuestion(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByRequired(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByAffirmationRequired(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByNeedsOneResponse(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. InquirySearchOrderRecord getInquirySearchOrderRecord(Type inquiryRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.inquiryRecordType
- an inquiry record typeNullArgumentException
- inquiryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inquiryRecordType)
is false
mandatory
- This method must be implemented.