Interface ForumSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ForumQuerySession, OsidSession, OsidSession

public interface ForumSearchSession
extends ForumQuerySession

This session provides methods for searching Forums. The search query is constructed using the ForumQuery. The forum record Type also specifies the record for the forum query.

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

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

Method Summary

Modifier and Type	Method	Description
ForumQuery	getForumQueryFromInspector(ForumQueryInspector forumQueryInspector)	Gets a forum query from an inspector.
ForumSearchResults	getForumsBySearch(ForumQuery forumQuery, ForumSearch forumSearch)	Gets the search results matching the given search.
ForumSearch	getForumSearch()	Gets a forum search.
ForumSearchOrder	getForumSearchOrder()	Gets a forum search order.

Methods inherited from interface Closeable

close

Methods inherited from interface ForumQuerySession

canSearchForums, getForumQuery, getForumsByQuery

Modifier and Type	Method	Description
boolean	canSearchForums()	Tests if this user can perform Forum searches.
ForumQuery	getForumQuery()	Gets a forum query.
ForumList	getForumsByQuery(ForumQuery forumQuery)	Gets a list of Forums matching the given search.

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

getForumSearch

ForumSearch getForumSearch()

Gets a forum search.

Returns:

the forum search

Compliance:

mandatory - This method must be implemented.

getForumSearchOrder

ForumSearchOrder getForumSearchOrder()

Gets a forum search order. The ForumSearchOrder is supplied to a ForumSearch to specify the ordering of results.

Returns:

the forum search order

Compliance:

mandatory - This method must be implemented.

getForumsBySearch

ForumSearchResults getForumsBySearch(ForumQuery forumQuery,
 ForumSearch forumSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

forumQuery - the forum query

forumSearch - the forum search

Returns:

the forum search results

Throws:

NullArgumentException - forumQuery or forumSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - forumQuery or forumSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getForumQueryFromInspector

ForumQuery getForumQueryFromInspector(ForumQueryInspector forumQueryInspector)

Gets a forum query from an inspector. The inspector is available from an ForumSearchResults.

Parameters:

forumQueryInspector - a query inspector

Returns:

the forum query

Throws:

NullArgumentException - forumQueryInspector is null

UnsupportedException - forumQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.