Interface CommentSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CommentQuerySession, OsidSession, OsidSession

public interface CommentSearchSession
extends CommentQuerySession

This session provides methods for searching Comments. The search query is constructed using the CommentQuery. The comment record Type also specifies the record for the comment query.

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

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

Method Summary

Modifier and Type	Method	Description
CommentQuery	getCommentQueryFromInspector(CommentQueryInspector commentQueryInspector)	Gets an entry query from an inspector.
CommentSearchResults	getCommentsBySearch(CommentQuery commentQuery, CommentSearch commentSearch)	Gets the search results matching the given search.
CommentSearch	getCommentSearch()	Gets a comment search.
CommentSearchOrder	getCommentSearchOrder()	Gets a comment search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CommentQuerySession

canSearchComments, getBook, getBookId, getCommentQuery, getCommentsByQuery, useFederatedBookView, useIsolatedBookView

Modifier and Type	Method	Description
boolean	canSearchComments()	Tests if this user can perform comment searches.
Book	getBook()	Gets the Book associated with this session.
Id	getBookId()	Gets the Book Id associated with this session.
CommentQuery	getCommentQuery()	Gets a comment query.
CommentList	getCommentsByQuery(CommentQuery commentQuery)	Gets a list of comments matching the given search.
void	useFederatedBookView()	Federates the view for methods in this session.
void	useIsolatedBookView()	Isolates the view for methods in this session.

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

getCommentSearch

CommentSearch getCommentSearch()

Gets a comment search.

Returns:

the comment search

Compliance:

mandatory - This method must be implemented.

getCommentSearchOrder

CommentSearchOrder getCommentSearchOrder()

Gets a comment search order. The CommentSearchOrder is supplied to a CommentSearch to specify the ordering of results.

Returns:

the comment search order

Compliance:

mandatory - This method must be implemented.

getCommentsBySearch

CommentSearchResults getCommentsBySearch(CommentQuery commentQuery,
 CommentSearch commentSearch)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

commentQuery - the comment query

commentSearch - the comment search

Returns:

the search results

Throws:

NullArgumentException - commentQuery or commentSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - commentQuery or commentSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCommentQueryFromInspector

CommentQuery getCommentQueryFromInspector(CommentQueryInspector commentQueryInspector)

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

Parameters:

commentQueryInspector - a comment query inspector

Returns:

the entry query

Throws:

NullArgumentException - commentQueryInspector is null

UnsupportedException - commentQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.