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

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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.