Interface BlogSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BlogSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BlogQueryInspector	getBlogQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BlogList	getBlogs()	Gets the blog list resulting from the search.
BlogSearchResultsRecord	getBlogSearchResultsRecord(Type blogSearchRecordType)	Gets the blog search results record corresponding to the given blog 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

getBlogs

BlogList getBlogs()

Gets the blog list resulting from the search. This is a retrieve-once method. Another list may be created through performing another search.

Returns:

the blog list

Throws:

IllegalStateException - the blog list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBlogQueryInspector

BlogQueryInspector getBlogQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getBlogSearchResultsRecord

BlogSearchResultsRecord getBlogSearchResultsRecord(Type blogSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

blogSearchRecordType - a blog search record type

Returns:

the blog search rsults record

Throws:

NullArgumentException - blogSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(blogSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.