public interface BranchSearchOrder extends OsidObjectSearchOrder, OsidOperableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
BranchSearchOrderRecord |
getBranchSearchOrderRecord(Type branchRecordType)
Gets the branch search order record corresponding to the given branch
record
Type. |
JournalEntrySearchOrder |
getLatestJournalEntrySearchOrder()
Gets the search order for the latest journal entry.
|
JournalEntrySearchOrder |
getOriginJournalEntrySearchOrder()
Gets the search order for the origin journal entry.
|
void |
orderByLatestJournalEntry(SearchOrderStyle style)
Specified a preference for ordering results by the latest journal
entry.
|
void |
orderByOriginJournalEntry(SearchOrderStyle style)
Specified a preference for ordering results by the origin journal
entry.
|
boolean |
supportsLatestJournalEntrySearchOrder()
Tests if a
JournalEntrySearchOrder is available. |
boolean |
supportsOriginJournalEntrySearchOrder()
Tests if a
JournalEntrySearchOrder is available. |
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByOriginJournalEntry(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsOriginJournalEntrySearchOrder()
JournalEntrySearchOrder
is available. true
if a journal entry search order is
available, false
otherwisemandatory
- This method must be implemented. JournalEntrySearchOrder getOriginJournalEntrySearchOrder()
UnimplementedException
-
supportsOriginJournalEntrySearchOrder()
is
false
optional
- This method must be implemented if
supportsOriginJournalEntrySearchOrder()
is
true.
void orderByLatestJournalEntry(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsLatestJournalEntrySearchOrder()
JournalEntrySearchOrder
is available. true
if a journal entry search order is
available, false
otherwisemandatory
- This method must be implemented. JournalEntrySearchOrder getLatestJournalEntrySearchOrder()
UnimplementedException
-
supportsLatestJournalEntrySearchOrder()
is
false
optional
- This method must be implemented if
supportsLatestJournalEntrySearchOrder()
is
true.
BranchSearchOrderRecord getBranchSearchOrderRecord(Type branchRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.branchRecordType
- a branch record typeNullArgumentException
- branchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(branchRecordType)
is false
mandatory
- This method must be implemented.