org.osid.forum

Interface ReplySearchOrder

All Superinterfaces:

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

public interface ReplySearchOrder
extends OsidObjectSearchOrder, OsidContainableSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ResourceSearchOrder	getPosterSearchOrder() Gets the resource search order interface.
AgentSearchOrder	getPostingAgentSearchOrder() Gets the posting agent search order interface.
ReplySearchOrderRecord	getReplySearchOrderRecord(Type replyRecordType) Gets the reply search order record corresponding to the given reply record Type.
void	orderByPoster(SearchOrderStyle style) Specifies a preference for ordering the result set by the poster.
void	orderByPostingAgent(SearchOrderStyle style) Specifies a preference for ordering the result set by the posting agent.
void	orderBySubjectLine(SearchOrderStyle style) Specifies a preference for ordering the result set by the subject.
void	orderByText(SearchOrderStyle style) Specifies a preference for ordering the result set by the text.
void	orderByTimestamp(SearchOrderStyle style) Specifies a preference for ordering the result set by the timestamp.
boolean	supportsPosterSearchOrder() Tests if a poster resource search order interface is available.
boolean	supportsPostingAgentSearchOrder() Tests if a posting agent search 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.OsidContainableSearchOrder

orderBySequestered

Method Detail

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.

orderByPoster

void orderByPoster(SearchOrderStyle style)

Specifies a preference for ordering the result set 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 poster resource search order interface is available.

Returns:

true if a resource search order interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPosterSearchOrder

ResourceSearchOrder getPosterSearchOrder()

Gets the resource search order interface.

Returns:

the resource search order interface

Throws:

UnimplementedException - supportsPosterSearchOrder() is false

Compliance:

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

orderByPostingAgent

void orderByPostingAgent(SearchOrderStyle style)

Specifies a preference for ordering the result set 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 a posting agent search order interface is available.

Returns:

true if a agent search order interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPostingAgentSearchOrder

AgentSearchOrder getPostingAgentSearchOrder()

Gets the posting agent search 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 the result set by the subject.

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 the result set by the text.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getReplySearchOrderRecord

ReplySearchOrderRecord getReplySearchOrderRecord(Type replyRecordType)
                                                 throws OperationFailedException

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

Parameters:

replyRecordType - a reply record type

Returns:

the reply search order record

Throws:

NullArgumentException - replyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(replyRecordType) is false

Compliance:

mandatory - This method must be implemented.