org.osid.forum

Interface PostSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PostQuerySession

public interface PostSearchSession
extends PostQuerySession

This session provides methods for searching Post objects. 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

Methods

Modifier and Type	Method and 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 org.osid.forum.PostQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.