OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LogEntryQuery
Implementsosid.OsidObjectQuery
Description

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

MethodmatchPriority
Description

Matches a priority Type for the log entry.

Parametersosid.type.TypepriorityType Type to match
booleanmatch true if for a positive match, false for a negative match
ErrorsNULL_ARGUMENT priorityType is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyPriority
Description

Matches log entries with any priority.

Parametersbooleanmatch true to match log entries with any priority, false to match log entries with no priority
CompliancemandatoryThis method must be implemented.
MethodclearPriorityTerms
Description

Clears the priority terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumPriority
Description

Matches a log entries including and above the given priority type.

Parametersosid.type.TypepriorityType Type to match
booleanmatch true if for a positive match, false for a negative match
ErrorsNULL_ARGUMENT priorityType is null
CompliancemandatoryThis method must be implemented.
MethodclearMinimumPriorityTerms
Description

Clears the minimum priority terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimestamp
Description

Matches the time of this log entry.

Parametersosid.calendaring.DateTimestartTimestart time
osid.calendaring.DateTimeendTimeend time
booleanmatch true if for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT startTime is greater than endTime
NULL_ARGUMENT startTime or endTime is null
CompliancemandatoryThis method must be implemented.
MethodclearTimestampTerms
Description

Clears the timestamp terms.

CompliancemandatoryThis method must be implemented.
MethodmatchResourceId
Description

Matches a resource in this log entry.

Parametersosid.id.IdresourceId Id to match
booleanmatch true if for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearResourceIdTerms
Description

Clears the resource Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResourceQuery
Description

Tests if a ResourceQuery is available for querying agents.

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

Gets the query for a resource.

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsResourceQuery() is true.
MethodclearResourceTerms
Description

Clears the resource terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAgentId
Description

Matches an agent in this log entry.

Parametersosid.id.IdagentId Id to match
booleanmatch true if for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearAgentIdTerms
Description

Clears the agent Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAgentQuery
Description

Tests if an AgentQuery is available for querying agents.

Returnboolean true if an agent query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgentQuery
Description

Gets the query for an agent.

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsAgentQuery() is true.
MethodclearAgentTerms
Description

Clears the agent terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLogId
Description

Matches a log.

Parametersosid.id.IdlogId Id to match
booleanmatch true if for a positive match, false for a negative match
ErrorsNULL_ARGUMENT logId is null
CompliancemandatoryThis method must be implemented.
MethodclearLogIdTerms
Description

Clears the log Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLogQuery
Description

Tests if a LogQuery is available for querying logs.

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

Gets the query for a log.

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

Clears the log terms.

CompliancemandatoryThis method must be implemented.
MethodgetLogEntryQueryRecord
Description

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

Parametersosid.type.TypelogEntryRecordTypea log entry record type
Returnosid.logging.records.LogEntryQueryRecordthe log entry query record
ErrorsNULL_ARGUMENT logEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(logEutryRecordType) is false
CompliancemandatoryThis method must be implemented.