org.osid.logging

Interface LogSearchSession

All Superinterfaces:

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

public interface LogSearchSession
extends LogQuerySession

This session provides methods for searching Log objects. The search query is constructed using the LogQuery . The log record Type also specifies the record for the log query.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
LogQuery	getLogQueryFromInspector(LogQueryInspector logQueryInspector) Gets a log query from an inspector.
LogSearchResults	getLogsBySearch(LogQuery logQuery, LogSearch logSearch) Gets the search results matching the given search.
LogSearch	getLogSearch() Gets a log search.
LogSearchOrder	getLogSearchOrder() Gets a log search order.

Methods inherited from interface org.osid.logging.LogQuerySession

canSearchLogs, getLogQuery, getLogsByQuery

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

getLogSearch

LogSearch getLogSearch()

Gets a log search.

Returns:

the log search

Compliance:

mandatory - This method must be implemented.

getLogSearchOrder

LogSearchOrder getLogSearchOrder()

Gets a log search order. The LogSearchOrder is supplied to a LogSearch to specify the ordering of results.

Returns:

the log search order

Compliance:

mandatory - This method must be implemented.

getLogsBySearch

LogSearchResults getLogsBySearch(LogQuery logQuery,
                               LogSearch logSearch)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets the search results matching the given search.

Parameters:

logQuery - the log query

logSearch - the log search

Returns:

the log search results

Throws:

NullArgumentException - logQuery or logSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - logQuery or logSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getLogQueryFromInspector

LogQuery getLogQueryFromInspector(LogQueryInspector logQueryInspector)

Gets a log query from an inspector. The inspector is available from a LogSearchResults.

Parameters:

logQueryInspector - a log query inspector

Returns:

the log query

Throws:

NullArgumentException - logQueryInspector is null

UnsupportedException - logQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.