Interface PostSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PostQuerySession

public interface PostSearchSession
extends PostQuerySession

This session provides methods for searching Posts. The search query is constructed using the PostQuery. The post record Type also specifies the record for the post query.

getPostsByQuery() is the basic search method and returns a list of Post elements. A more advanced search may be performed with getPostsBySearch(). It accepts a PostSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPostsBySearch() returns a PostSearchResults that can be used to access the resulting PostList or be used to perform a search within the result set through PostSearch.

Posts may have a query record indicated by their respective record types. The query record is accessed via the PostQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
PostQuery	getPostQueryFromInspector(PostQueryInspector postQueryInspector)	Gets an entry query from an inspector.
PostSearchResults	getPostsBySearch(PostQuery postQuery, PostSearch postSearch)	Gets the search results matching the given search.
PostSearch	getPostSearch()	Gets a post search.
PostSearchOrder	getPostSearchOrder()	Gets a post search order.

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.

Methods inherited from interface PostQuerySession

canSearchPosts, getForum, getForumId, getPostQuery, getPostsByQuery, useFederatedForumView, useIsolatedForumView

Modifier and Type	Method	Description
boolean	canSearchPosts()	Tests if this user can perform Post searches.
Forum	getForum()	Gets the Forum associated with this session.
Id	getForumId()	Gets the Forum Id associated with this session.
PostQuery	getPostQuery()	Gets a post query.
PostList	getPostsByQuery(PostQuery postQuery)	Gets a list of Posts matching the given search.
void	useFederatedForumView()	Federates the view for methods in this session.
void	useIsolatedForumView()	Isolates the view for methods in this session.

Method Details

getPostSearch

PostSearch getPostSearch()

Gets a post search.

Returns:

the post search

Compliance:

mandatory - This method must be implemented.

getPostSearchOrder

PostSearchOrder getPostSearchOrder()

Gets a post search order. The PostSearchOrder is supplied to a PostSearch to specify the ordering of results.

Returns:

the post search order

Compliance:

mandatory - This method must be implemented.

getPostsBySearch

PostSearchResults getPostsBySearch(PostQuery postQuery,
 PostSearch postSearch)
                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

postQuery - the post query

postSearch - the post search

Returns:

the post search results

Throws:

NullArgumentException - postQuery or postSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - postQuery or postSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPostQueryFromInspector

PostQuery getPostQueryFromInspector(PostQueryInspector postQueryInspector)

Gets an entry query from an inspector. The inspector is available from an PostSearchResults.

Parameters:

postQueryInspector - a query inspector

Returns:

the entry query

Throws:

NullArgumentException - postQueryInspector is null

UnsupportedException - postQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.