OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.BranchSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidOperableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByOriginJournalEntry
Description

Specified a preference for ordering results by the origin journal entry.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsOriginJournalEntrySearchOrder
Description

Tests if a JournalEntrySearchOrder is available.

Returnboolean true if a journal entry search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOriginJournalEntrySearchOrder
Description

Gets the search order for the origin journal entry.

Returnosid.journaling.JournalEntrySearchOrderthe journal entry search order
ErrorsUNIMPLEMENTED supportsOriginJournalEntrySearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsOriginJournalEntrySearchOrder() is true.
MethodorderByLatestJournalEntry
Description

Specified a preference for ordering results by the latest journal entry.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsLatestJournalEntrySearchOrder
Description

Tests if a JournalEntrySearchOrder is available.

Returnboolean true if a journal entry search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLatestJournalEntrySearchOrder
Description

Gets the search order for the latest journal entry.

Returnosid.journaling.JournalEntrySearchOrderthe journal entry search order
ErrorsUNIMPLEMENTED supportsLatestJournalEntrySearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsLatestJournalEntrySearchOrder() is true.
MethodgetBranchSearchOrderRecord
Description

Gets the branch search order record corresponding to the given branch record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypebranchRecordTypea branch record type
Returnosid.journaling.records.BranchSearchOrderRecordthe branch search order record
ErrorsNULL_ARGUMENT branchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(branchRecordType) is false
CompliancemandatoryThis method must be implemented.