org.osid.journaling

Interface BranchSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, Suppliable

public interface BranchSearchOrder
extends OsidObjectSearchOrder, OsidOperableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

orderByOriginJournalEntry

void orderByOriginJournalEntry(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsOriginJournalEntrySearchOrder

boolean supportsOriginJournalEntrySearchOrder()

Tests if a JournalEntrySearchOrder is available.

Returns:

true if a journal entry search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOriginJournalEntrySearchOrder

JournalEntrySearchOrder getOriginJournalEntrySearchOrder()

Gets the search order for the origin journal entry.

Returns:

the journal entry search order

Throws:

UnimplementedException - supportsOriginJournalEntrySearchOrder() is false

Compliance:

optional - This method must be implemented if supportsOriginJournalEntrySearchOrder() is true.

orderByLatestJournalEntry

void orderByLatestJournalEntry(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsLatestJournalEntrySearchOrder

boolean supportsLatestJournalEntrySearchOrder()

Tests if a JournalEntrySearchOrder is available.

Returns:

true if a journal entry search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLatestJournalEntrySearchOrder

JournalEntrySearchOrder getLatestJournalEntrySearchOrder()

Gets the search order for the latest journal entry.

Returns:

the journal entry search order

Throws:

UnimplementedException - supportsLatestJournalEntrySearchOrder() is false

Compliance:

optional - This method must be implemented if supportsLatestJournalEntrySearchOrder() is true.

getBranchSearchOrderRecord

BranchSearchOrderRecord getBranchSearchOrderRecord(Type branchRecordType)
                                                   throws OperationFailedException

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

Parameters:

branchRecordType - a branch record type

Returns:

the branch search order record

Throws:

NullArgumentException - branchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(branchRecordType) is false

Compliance:

mandatory - This method must be implemented.