OSID Logo
OSID Specifications
logging package
Version 3.1.0
Interfaceosid.logging.LogSearchSession
Implementsosid.logging.LogQuerySession
Used Byosid.logging.LoggingManager
osid.logging.LoggingProxyManager
Description

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.

MethodgetLogSearch
Description

Gets a log search.

Returnosid.logging.LogSearch the log search
Compliancemandatory This method must be implemented.
MethodgetLogSearchOrder
Description

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

Returnosid.logging.LogSearchOrder the log search order
Compliancemandatory This method must be implemented.
MethodgetLogsBySearch
Description

Gets the search results matching the given search.

Parametersosid.logging.LogQuerylogQuery the log query
osid.logging.LogSearchlogSearch the log search
Returnosid.logging.LogSearchResults the log search results
ErrorsNULL_ARGUMENT logQuery or logSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED logQuery or logSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetLogQueryFromInspector
Description

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

Parametersosid.logging.LogQueryInspectorlogQueryInspector a log query inspector
Returnosid.logging.LogQuery the log query
ErrorsNULL_ARGUMENT logQueryInspector is null
UNSUPPORTED logQueryInspector is not of this service
Compliancemandatory This method must be implemented.