Interface ReplySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ReplySearch
extends OsidSearch

The search interface for governing reply searches.

Method Summary

Modifier and Type	Method	Description
ReplySearchRecord	getReplySearchRecord(Type replySearchRecordType)	Gets the reply search record corresponding to the given reply search record Type.
void	orderReplyResults(ReplySearchOrder replySearchOrder)	Specify an ordering to the search results.
void	searchAmongReplies(IdList replyIds)	Execute this search among the given list of replies.

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

searchAmongReplies

void searchAmongReplies(IdList replyIds)

Execute this search among the given list of replies.

Parameters:

replyIds - list of replies

Throws:

NullArgumentException - replyIds is null

Compliance:

mandatory - This method must be implemented.

orderReplyResults

void orderReplyResults(ReplySearchOrder replySearchOrder)

Specify an ordering to the search results.

Parameters:

replySearchOrder - reply search order

Throws:

NullArgumentException - replySearchOrder is null

UnsupportedException - replySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getReplySearchRecord

ReplySearchRecord getReplySearchRecord(Type replySearchRecordType)
                                throws OperationFailedException

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

Parameters:

replySearchRecordType - a reply search record type

Returns:

the reply search record

Throws:

NullArgumentException - replySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(replySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.