OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LogEntrySearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByPriority
Description

Specifies a preference for ordering log entris by priority type.

Parametersosid.SearchOrderStylestylesearch otrder style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByTimestamp
Description

Specifies a preference for ordering log entries by time.

Parametersosid.SearchOrderStylestylesearch otrder style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByResource
Description

Specifies a preference for ordering log entries by resource.

Parametersosid.SearchOrderStylestylesearch otrder style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsResourceSearchOrder
Description

Tests if a resource order is available.

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

Gets the resource order.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsResourceSearchOrder() is true.
MethodorderByAgent
Description

Specifies a preference for ordering log entries by agent.

Parametersosid.SearchOrderStylestylesearch otrder style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsAgentSearchOrder
Description

Tests if an agent order is available.

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

Gets the agent order.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsUNIMPLEMENTED supportsAgentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAgentSearchOrder() is true.
MethodgetLogEntrySearchOrderRecord
Description

Gets the log entry search order record corresponding to the given log entry record Type. Multiple retrievals return the same underlying object.

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