org.osid.logging

Interface LogEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface LogEntrySearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

Modifier and Type	Method and Description
LogEntryList	getLogEntries() Gets the log entry list resulting from a search.
LogEntryQueryInspector	getLogEntryQueryInspector() Gets the inspector for the query to examine the terms used in the search.
LogEntrySearchResultsRecord	getLogEntrySearchResultsRecord(Type logEntrySearchRecordType) Gets the log entry search results record corresponding to the given log entry search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getLogEntries

LogEntryList getLogEntries()

Gets the log entry list resulting from a search.

Returns:

the log entry list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getLogEntryQueryInspector

LogEntryQueryInspector getLogEntryQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the log entry query inspector

Compliance:

mandatory - This method must be implemented.

getLogEntrySearchResultsRecord

LogEntrySearchResultsRecord getLogEntrySearchResultsRecord(Type logEntrySearchRecordType)
                                                           throws OperationFailedException

Gets the log entry search results record corresponding to the given log entry search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

logEntrySearchRecordType - a log entry search record type

Returns:

the log entry search results record

Throws:

NullArgumentException - logEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.