org.osid.commenting

Interface CommentSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CommentSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
CommentQueryInspector	getCommentQueryInspector() Gets the inspector for the query to examine the terns used in the search.
CommentList	getComments() Gets the comment list resulting from a search.
CommentSearchResultsRecord	getCommentSearchResultsRecord(Type commentSearchRecordType) Gets the comment search results record corresponding to the given comment 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

getComments

CommentList getComments()

Gets the comment list resulting from a search.

Returns:

the comment list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCommentQueryInspector

CommentQueryInspector getCommentQueryInspector()

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.

getCommentSearchResultsRecord

CommentSearchResultsRecord getCommentSearchResultsRecord(Type commentSearchRecordType)
                                                         throws OperationFailedException

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

Throws:

NullArgumentException - commentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.