public interface IssueSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ResourceSearchOrder |
getBureauSearchOrder()
Gets the resource search order.
|
IssueSearchOrderRecord |
getIssueSearchOrderRecord(Type issueRecordType)
Gets the issue search order record corresponding to the given issue
record
Type. |
void |
orderByBureau(SearchOrderStyle style)
Orders the results by resource.
|
boolean |
supportsBureauSearchOrder()
Tests if a resource search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByBureau(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsBureauSearchOrder()
true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getBureauSearchOrder()
IllegalStateException
-
supportsResourceSearchOrder()
is false
mandatory
- This method must be implemented. IssueSearchOrderRecord getIssueSearchOrderRecord(Type issueRecordType) throws OperationFailedException, PermissionDeniedException
Type.
Multiple retrievals return the same
underlying object.issueRecordType
- an issue record typeNullArgumentException
- issueRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(issueRecordType)
is false
mandatory
- This method must be implemented.