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

Modifier and Type	Method	Description
PostQueryInspector	getPostQueryInspector()	Gets the inspector for the query to examine the periods 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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getPosts

PostList getPosts()

Gets the post list resulting from a search.

Returns:

the post list

Throws:

IllegalStateException - the post list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPostQueryInspector

PostQueryInspector getPostQueryInspector()

Gets the inspector for the query to examine the periods 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.