Interface | osid.journaling.BranchSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidOperableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByOriginJournalEntry | ||
Description |
Specified a preference for ordering results by the origin journal entry. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsOriginJournalEntrySearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a journal entry search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOriginJournalEntrySearchOrder | ||
Description |
Gets the search order for the origin journal entry. | ||
Return | osid.journaling.JournalEntrySearchOrder | the journal entry search order | |
Errors | UNIMPLEMENTED | supportsOriginJournalEntrySearchOrder() is false
| |
Compliance | optional | This method must be implemented if
supportsOriginJournalEntrySearchOrder() is true. | |
Method | orderByLatestJournalEntry | ||
Description |
Specified a preference for ordering results by the latest journal entry. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLatestJournalEntrySearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a journal entry search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLatestJournalEntrySearchOrder | ||
Description |
Gets the search order for the latest journal entry. | ||
Return | osid.journaling.JournalEntrySearchOrder | the journal entry search order | |
Errors | UNIMPLEMENTED | supportsLatestJournalEntrySearchOrder() is false
| |
Compliance | optional | This method must be implemented if
supportsLatestJournalEntrySearchOrder() is true. | |
Method | getBranchSearchOrderRecord | ||
Description |
Gets the branch search order record corresponding to
the given branch record | ||
Parameters | osid.type.Type | branchRecordType | a branch record type |
Return | osid.journaling.records.BranchSearchOrderRecord | the branch search order record | |
Errors | NULL_ARGUMENT | branchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(branchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |