org.osid.blogging

Interface EntrySearchOrder

All Superinterfaces:

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

public interface EntrySearchOrder
extends OsidObjectSearchOrder, OsidSourceableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
EntrySearchOrderRecord	getEntrySearchOrderRecord(Type entryRecordType) Gets the entry search order record interface corresponding to the given entry record Type.
ResourceSearchOrder	getPosterSearchOrder() Gets the poster resource search order interface.
AgentSearchOrder	getPostingAgentSearchOrder() Gets the posting agent order interface.
void	orderByPoster(SearchOrderStyle style) Specifies a preference for ordering entries by the poster.
void	orderByPostingAgent(SearchOrderStyle style) Specifies a preference for ordering entries by the posting agent.
void	orderBySubjectLine(SearchOrderStyle style) Specifies a preference for ordering entries by subject line.
void	orderBySummary(SearchOrderStyle style) Specifies a preference for ordering entries by summary.
void	orderByText(SearchOrderStyle style) Specifies a preference for ordering entries by text.
void	orderByTimestamp(SearchOrderStyle style) Specifies a preference for ordering entries by time.
boolean	supportsPosterSearchOrder() Tests if a resource order interface is available.
boolean	supportsPostingAgentSearchOrder() Tests if an agent order interface 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.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

orderByTimestamp

void orderByTimestamp(SearchOrderStyle style)

Specifies a preference for ordering entries by time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByPoster

void orderByPoster(SearchOrderStyle style)

Specifies a preference for ordering entries by the poster.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsPosterSearchOrder

boolean supportsPosterSearchOrder()

Tests if a resource order interface is available.

Returns:

true if a resource order interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPosterSearchOrder

ResourceSearchOrder getPosterSearchOrder()

Gets the poster resource search order interface.

Returns:

the resource search order interface

Throws:

UnimplementedException - supportsResourceSearchOrder() is false

Compliance:

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

orderByPostingAgent

void orderByPostingAgent(SearchOrderStyle style)

Specifies a preference for ordering entries by the posting agent.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsPostingAgentSearchOrder

boolean supportsPostingAgentSearchOrder()

Tests if an agent order interface is available.

Returns:

true if an agent order interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPostingAgentSearchOrder

AgentSearchOrder getPostingAgentSearchOrder()

Gets the posting agent order interface.

Returns:

the agent search order interface

Throws:

UnimplementedException - supportsPostingAgentSearchOrder() is false

Compliance:

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

orderBySubjectLine

void orderBySubjectLine(SearchOrderStyle style)

Specifies a preference for ordering entries by subject line.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySummary

void orderBySummary(SearchOrderStyle style)

Specifies a preference for ordering entries by summary.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByText

void orderByText(SearchOrderStyle style)

Specifies a preference for ordering entries by text.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getEntrySearchOrderRecord

EntrySearchOrderRecord getEntrySearchOrderRecord(Type entryRecordType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

entryRecordType - an entry record type

Returns:

the entry search order record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.