org.osid.journaling

Interface JournalEntrySearchOrder

All Superinterfaces:

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

public interface JournalEntrySearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AgentSearchOrder	getAgentSearchOrder() Gets the agent order.
BranchSearchOrder	getBranchSearchOrder() Gets the branch search order.
JournalEntrySearchOrderRecord	getJournalEntrySearchOrderRecord(Type journalEntryRecordType) Gets the journal entry search order record corresponding to the given journal entry record Type.
ResourceSearchOrder	getResourceSearchOrder() Gets the resource order.
void	orderByAgent(SearchOrderStyle style) Specifies a preference for ordering the result set by the agent.
void	orderByBranch(SearchOrderStyle style) Specifies a preference for ordering the result set by the branch.
void	orderByResource(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
void	orderBySource(SearchOrderStyle style) Specifies a preference for ordering the result set by the source.
void	orderByTimestamp(SearchOrderStyle style) Specifies a preference for ordering the result set by the timestamp.
boolean	supportsAgentSearchOrder() Tests if an agent order is available.
boolean	supportsBranchSearchOrder() Tests if a branch search order is available.
boolean	supportsResourceSearchOrder() Tests if a resource order 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

Method Detail

orderByBranch

void orderByBranch(SearchOrderStyle style)

Specifies a preference for ordering the result set by the branch.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsBranchSearchOrder

boolean supportsBranchSearchOrder()

Tests if a branch search order is available.

Returns:

true if a branch order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBranchSearchOrder

BranchSearchOrder getBranchSearchOrder()

Gets the branch search order.

Returns:

the branch search order

Throws:

UnimplementedException - supportsBranchSearchOrder() is false

Compliance:

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

orderBySource

void orderBySource(SearchOrderStyle style)

Specifies a preference for ordering the result set by the source.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTimestamp

void orderByTimestamp(SearchOrderStyle style)

Specifies a preference for ordering the result set by the timestamp.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByResource

void orderByResource(SearchOrderStyle style)

Specifies a preference for ordering the result set by the resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a resource order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets the resource order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsResourceSearchOrder() is false

Compliance:

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

orderByAgent

void orderByAgent(SearchOrderStyle style)

Specifies a preference for ordering the result set by the agent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAgentSearchOrder

boolean supportsAgentSearchOrder()

Tests if an agent order is available.

Returns:

true if an agent order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgentSearchOrder

AgentSearchOrder getAgentSearchOrder()

Gets the agent order.

Returns:

the agent search order

Throws:

UnimplementedException - supportsAgentSearchOrder() is false

Compliance:

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

getJournalEntrySearchOrderRecord

JournalEntrySearchOrderRecord getJournalEntrySearchOrderRecord(Type journalEntryRecordType)
                                                               throws OperationFailedException

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

Parameters:

journalEntryRecordType - a journal entry record type

Returns:

the journal entry search order record

Throws:

NullArgumentException - journalEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.