org.osid.forum

Interface PostSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PostSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
PostQueryInspector	getPostQueryInspector() Gets the inspector for the query to examine the terns used in the search.
PostList	getPosts() Gets the post list resulting from a search.
PostSearchResultsRecord	getPostSearchResultsRecord(Type postSearchRecordType) Gets the post search results record corresponding to the given post 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

getPosts

PostList getPosts()

Gets the post list resulting from a search.

Returns:

the post list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPostQueryInspector

PostQueryInspector getPostQueryInspector()

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.

getPostSearchResultsRecord

PostSearchResultsRecord getPostSearchResultsRecord(Type postSearchRecordType)
                                                   throws OperationFailedException

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

Parameters:

postSearchRecordType - a post search record type

Returns:

the post search results record

Throws:

NullArgumentException - PostSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.