Interface LogSearchSession

All Superinterfaces:

AutoCloseable, Closeable, LogQuerySession, OsidSession, OsidSession

public interface LogSearchSession
extends LogQuerySession

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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface LogQuerySession

canSearchLogs, getLogQuery, getLogsByQuery

Modifier and Type	Method	Description
boolean	canSearchLogs()	Tests if this user can perform Log searches.
LogQuery	getLogQuery()	Gets a log query.
LogList	getLogsByQuery(LogQuery logQuery)	Gets a list of Logs matching the given log query.

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

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.