Interface BlogSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BlogSearch
extends OsidSearch

The interface for governing blog searches.

Method Summary

Modifier and Type	Method	Description
BlogSearchRecord	getBlogSearchRecord(Type blogSearchRecordType)	Gets the blog search record corresponding to the given blog search record Type.
void	orderBlogResults(BlogSearchOrder blogSearchOrder)	Specify an ordering to the search results.
void	searchAmongBlogs(IdList blogIds)	Execute this search among the given list of blogs.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongBlogs

void searchAmongBlogs(IdList blogIds)

Execute this search among the given list of blogs.

Parameters:

blogIds - list of blogs

Throws:

NullArgumentException - blogIds is null

Compliance:

mandatory - This method must be implemented.

orderBlogResults

void orderBlogResults(BlogSearchOrder blogSearchOrder)

Specify an ordering to the search results.

Parameters:

blogSearchOrder - blog search order

Throws:

NullArgumentException - blogSearchOrder is null

UnsupportedException - blogSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBlogSearchRecord

BlogSearchRecord getBlogSearchRecord(Type blogSearchRecordType)
                              throws OperationFailedException

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

Throws:

NullArgumentException - blogSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(blogSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.