Interface LogSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface LogSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
LogQueryInspector	getLogQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
LogList	getLogs()	Gets the log list resulting from a search.
LogSearchResultsRecord	getLogSearchResultsRecord(Type logSearchRecordType)	Gets the log search results record corresponding to the given log search record Type.

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

getLogs

LogList getLogs()

Gets the log list resulting from a search.

Returns:

the log list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getLogQueryInspector

LogQueryInspector getLogQueryInspector()

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

Returns:

the log query inspector

Compliance:

mandatory - This method must be implemented.

getLogSearchResultsRecord

LogSearchResultsRecord getLogSearchResultsRecord(Type logSearchRecordType)
                                          throws OperationFailedException

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

Parameters:

logSearchRecordType - a log search record type

Returns:

the log search results record

Throws:

NullArgumentException - logSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.