org.osid.forum

Interface ReplySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ReplySearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

Modifier and Type	Method and Description
ReplyList	getReplies() Gets the reply list resulting from a search.
ReplyQueryInspector	getReplyQueryInspector() Gets the inspector for the query to examine the terns used in the search.
ReplySearchResultsRecord	getReplySearchResultsRecord(Type replySearchRecordType) Gets the reply search results record corresponding to the given reply search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getReplies

ReplyList getReplies()

Gets the reply list resulting from a search.

Returns:

the reply list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getReplyQueryInspector

ReplyQueryInspector getReplyQueryInspector()

Gets the inspector for the query to examine the terns used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getReplySearchResultsRecord

ReplySearchResultsRecord getReplySearchResultsRecord(Type replySearchRecordType)
                                                     throws OperationFailedException

Gets the reply search results 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 results record

Throws:

NullArgumentException - replySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(replySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.