Interface LogEntrySearchSession

All Superinterfaces:

AutoCloseable, Closeable, LogEntryQuerySession, OsidSession, OsidSession

public interface LogEntrySearchSession
extends LogEntryQuerySession

This session provides methods for searching among log entries. The search query is constructed using the LogEntryQuery.

getLogEntriesByQuery() is the basic search method and returns a list of log entries. A more advanced search may be performed with getLogEntriesBySearch(). It accepts a LogEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getLogEntriesBySearch() returns a LogEntrySearchResults that can be used to access the resulting LogEntryList or be used to perform a search within the result set through LogEntrySearch.

This session defines views that offer differing behaviors for searching.

• federated log view: searches include entries in logs of which this log is an ancestor in the log hierarchy
• isolated log view: searches are restricted to entries in this log only

Method Summary

Modifier and Type	Method	Description
LogEntrySearchResults	getLogEntriesBySearch(LogEntryQuery logEntryQuery, LogEntrySearch logEntrySearch)	Gets the search results matching the given search query using the given search.
LogEntryQuery	getLogEntryQueryFromInspector(LogQueryInspector logEntryQueryInspector)	Gets a log entry query from an inspector.
LogEntrySearch	getLogEntrySearch()	Gets a log entry search.
LogEntrySearchOrder	getLogEntrySearchOrder()	Gets a log entry search order.

Methods inherited from interface Closeable

close

Methods inherited from interface LogEntryQuerySession

canSearchLogEntries, getLog, getLogEntriesByQuery, getLogEntryQuery, getLogId, useFederatedLogView, useIsolatedLogView

Modifier and Type	Method	Description
boolean	canSearchLogEntries()	Tests if this user can perform LogEntry searches.
Log	getLog()	Gets the Log associated with this session.
LogEntryList	getLogEntriesByQuery(LogEntryQuery logEntryQuery)	Gets a list of log entries matching the given log entry query
LogEntryQuery	getLogEntryQuery()	Gets a log entry query
Id	getLogId()	Gets the Log Id associated with this session.
void	useFederatedLogView()	Federates the view for methods in this session.
void	useIsolatedLogView()	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

getLogEntrySearch

LogEntrySearch getLogEntrySearch()

Gets a log entry search.

Returns:

the log entry search

Compliance:

mandatory - This method must be implemented.

getLogEntrySearchOrder

LogEntrySearchOrder getLogEntrySearchOrder()

Gets a log entry search order. The LogEntrySearchOrder is supplied to a LogEntrySearch to specify the ordering of results.

Returns:

the log entry search order

Compliance:

mandatory - This method must be implemented.

getLogEntriesBySearch

LogEntrySearchResults getLogEntriesBySearch(LogEntryQuery logEntryQuery,
 LogEntrySearch logEntrySearch)
                                     throws OperationFailedException,
PermissionDeniedException

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

Parameters:

logEntryQuery - the log entry query

logEntrySearch - the log entry search

Returns:

the returned search results

Throws:

NullArgumentException - logEntryQuery or logEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - logEntryQuery or logEntrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getLogEntryQueryFromInspector

LogEntryQuery getLogEntryQueryFromInspector(LogQueryInspector logEntryQueryInspector)

Gets a log entry query from an inspector. The inspector is available from a LogEntrySearchResults.

Parameters:

logEntryQueryInspector - a log entry query inspector

Returns:

the log entry query

Throws:

NullArgumentException - logEntryQueryInspector is null

UnsupportedException - logEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.