Interface BlogSearchSession

All Superinterfaces:

AutoCloseable, BlogQuerySession, Closeable, OsidSession, OsidSession

public interface BlogSearchSession
extends BlogQuerySession

This session provides methods for searching among Blogs . The search query is constructed using the BlogQuery .

getBlogsByQuery() is the basic search method and returns a list of Blog objects.A more advanced search may be performed with getBlogsBySearch() .It accepts a BlogSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBlogsBySearch() returns a BlogSearchResults that can be used to access the resulting BlogList or be used to perform a search within the result set through BlogSearch .

Blogs may have a query record indicated by their respective record types. The query record is accessed via the BlogQuery .

Method Summary

Modifier and Type	Method	Description
BlogQuery	getBlogQueryFromInspector(BlogQueryInspector blogQueryInspector)	Gets a blog query from an inspector.
BlogSearchResults	getBlogsBySearch(BlogQuery blogQuery, BlogSearch blogSearch)	Gets the search results matching the given search query using the given search.
BlogSearch	getBlogSearch()	Gets a blog search.
BlogSearchOrder	getBlogSearchOrder()	Gets a blog search order.

Methods inherited from interface BlogQuerySession

canSearchBlogs, getBlogQuery, getBlogsByQuery

Modifier and Type	Method	Description
boolean	canSearchBlogs()	Tests if this user can perform Blog searches.
BlogQuery	getBlogQuery()	Gets a blog query.
BlogList	getBlogsByQuery(BlogQuery blogQuery)	Gets a list of Blogs matching the given search.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getBlogSearch

BlogSearch getBlogSearch()

Gets a blog search.

Returns:

the blog search

Compliance:

mandatory - This method must be implemented.

getBlogSearchOrder

BlogSearchOrder getBlogSearchOrder()

Gets a blog search order. The BlogSearchOrder is supplied to a BlogSearch to specify the ordering of results.

Returns:

the blog search order

Compliance:

mandatory - This method must be implemented.

getBlogsBySearch

BlogSearchResults getBlogsBySearch(BlogQuery blogQuery,
 BlogSearch blogSearch)
                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

blogQuery - the blog query

blogSearch - the blog search

Returns:

the search results

Throws:

NullArgumentException - blogQuery or blogSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - blogQuery or blogSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBlogQueryFromInspector

BlogQuery getBlogQueryFromInspector(BlogQueryInspector blogQueryInspector)

Gets a blog query from an inspector. The inspector is available from an BlogSearchResults .

Parameters:

blogQueryInspector - a query inspector

Returns:

the blog query

Throws:

NullArgumentException - blogQueryInspector is null

UnsupportedException - blogQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.