org.osid.commenting

Interface CommentSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface CommentSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AgentSearchOrder	getCommentingAgentSearchOrder() Gets the agent order interface.
ResourceQuery	getCommentorSearchOrder() Gets the resource order interface.
CommentSearchOrderRecord	getCommentSearchOrderRecord(Type commentRecordType) Gets the comment search order record corresponding to the given comment record Type.
GradeSearchOrder	getRatingSearchOrder() Gets the rating order interface.
void	orderByCommentingAgent(SearchOrderStyle style) Specifies a preference for ordering the result set by the agent.
void	orderByCommentor(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
void	orderByRating(SearchOrderStyle style) Specifies a preference for ordering the result set by the rating.
void	orderByReference(SearchOrderStyle style) Specifies a preference for ordering the result set by the reference.
void	orderByText(SearchOrderStyle style) Specifies a preference for ordering the result set by the text.
boolean	supportsCommentingAgentSearchOrder() Tests if an agent order interface is available.
boolean	supportsCommentorSearchOrder() Tests if a resource order interface is available.
boolean	supportsRatingSearchOrder() Tests if a rating order interface is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByReference

void orderByReference(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCommentor

void orderByCommentor(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.

supportsCommentorSearchOrder

boolean supportsCommentorSearchOrder()

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.

getCommentorSearchOrder

ResourceQuery getCommentorSearchOrder()

Gets the resource order interface.

Returns:

the resource search order interface

Throws:

UnimplementedException - supportsCommentorSearchOrder() is false

Compliance:

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

orderByCommentingAgent

void orderByCommentingAgent(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.

supportsCommentingAgentSearchOrder

boolean supportsCommentingAgentSearchOrder()

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.

getCommentingAgentSearchOrder

AgentSearchOrder getCommentingAgentSearchOrder()

Gets the agent order interface.

Returns:

the agent search order interface

Throws:

UnimplementedException - supportsCommentingAgentSearchOrder() is false

Compliance:

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

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.

orderByRating

void orderByRating(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRatingSearchOrder

boolean supportsRatingSearchOrder()

Tests if a rating order interface is available.

Returns:

true if a rating order interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRatingSearchOrder

GradeSearchOrder getRatingSearchOrder()

Gets the rating order interface.

Returns:

the rating search order interface

Throws:

UnimplementedException - supportsRatingSearchOrder() is false

Compliance:

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

getCommentSearchOrderRecord

CommentSearchOrderRecord getCommentSearchOrderRecord(Type commentRecordType)
                                                     throws OperationFailedException

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

Parameters:

commentRecordType - a comment record type

Returns:

the comment search order record

Throws:

NullArgumentException - commentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commentRecordType) is false

Compliance:

mandatory - This method must be implemented.