OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LogQuery
Implementsosid.OsidCatalogQuery
Description

This is the query for searching for logs. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchLogEntryId
Description

Sets a log entry Id.

Parametersosid.id.IdlogEntryIda log entry Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT logEntryId is null
CompliancemandatoryThis method must be implemented.
MethodclearLogEntryIdTerms
Description

Clesrs the log entry Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLogEntryQuery
Description

Tests if a log entry query is available.

Returnboolean true if a log entry query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLogEntryQuery
Description

Gets the query for a log entry.

Returnosid.logging.LogEntryQuerythe log entry query
ErrorsUNIMPLEMENTED supportsLogEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsLogEntryQuery() is true.
MethodmatchAnyLogEntry
Description

Matches logs with any log entry.

Parametersbooleanmatch true to match logs with any entry, false to match logs with no log entries
CompliancemandatoryThis method must be implemented.
MethodclearLogEntryTerms
Description

Clesrs the log entry terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorLogId
Description

Sets the log Id for this query to match logs that have the specified log as an ancestor.

Parametersosid.id.IdlogIda log Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT logId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorLogIdTerms
Description

Clesrs the ancestor log Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorLogQuery
Description

Tests if a LogQuery is available.

Returnboolean true if a log query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorLogQuery
Description

Gets the query for a log. Multiple retrievals produce a nested OR term.

Returnosid.logging.LogQuerythe log query
ErrorsUNIMPLEMENTED supportsAncestorLogQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorLogQuery() is true.
MethodmatchAnyAncestorLog
Description

Matches logs with any ancestor.

Parametersbooleanmatch true to match logs with any ancestor, false to match root logs
CompliancemandatoryThis method must be implemented.
MethodclearAncestorLogTerms
Description

Clesrs the ancestor log terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantLogId
Description

Sets the log Id for this query to match logs that have the specified log as a descendant.

Parametersosid.id.IdlogIda log Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT logId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantLogIdTerms
Description

Clesrs the descendant log Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantLogQuery
Description

Tests if a LogQuery is available.

Returnboolean true if a log query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantLogQuery
Description

Gets the query for a log. Multiple retrievals produce a nested OR term.

Returnosid.logging.LogQuerythe log query
ErrorsUNIMPLEMENTED supportsDescendantLogQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantLogQuery() is true.
MethodmatchAnyDescendantLog
Description

Matches logs with any descendant.

Parametersbooleanmatch true to match logs with any descendant, false to match leaf logs
CompliancemandatoryThis method must be implemented.
MethodclearDescendantLogTerms
Description

Clesrs the descendant log terms.

CompliancemandatoryThis method must be implemented.
MethodgetLogQueryRecord
Description

Gets the log query record corresponding to the given Log record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypelogRecordTypea log record type
Returnosid.logging.records.LogQueryRecordthe log query record
ErrorsNULL_ARGUMENT logRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(logRecordType) is false
CompliancemandatoryThis method must be implemented.