Interface CommentSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CommentSearch
extends OsidSearch

The search interface for governing comment searches.

Method Summary

Modifier and Type	Method	Description
CommentSearchRecord	getCommentSearchRecord(Type commentSearchRecordType)	Gets the comment search record corresponding to the given comment search record Type .
void	orderCommentResults(CommentSearchOrder commentSearchOrder)	Specify an ordering to the search results.
void	searchAmongComments(IdList commentIds)	Execute this search among the given list of comments.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongComments

void searchAmongComments(IdList commentIds)

Execute this search among the given list of comments.

Parameters:

commentIds - list of comments

Throws:

NullArgumentException - commentIds is null

Compliance:

mandatory - This method must be implemented.

orderCommentResults

void orderCommentResults(CommentSearchOrder commentSearchOrder)

Specify an ordering to the search results.

Parameters:

commentSearchOrder - comment search order

Throws:

NullArgumentException - commentSearchOrder is null

UnsupportedException - commentSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCommentSearchRecord

CommentSearchRecord getCommentSearchRecord(Type commentSearchRecordType)
                                    throws OperationFailedException

Gets the comment search record corresponding to the given comment search record Type . This method is used to retrieve an object implementing the requested record.

Parameters:

commentSearchRecordType - a comment search record type

Returns:

the comment search record

Throws:

NullArgumentException - commentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.