org.osid.logging

Interface LogEntrySearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, LogEntryQuerySession, 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

Methods

Modifier and Type	Method and 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 org.osid.logging.LogEntryQuerySession

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

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

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.