Interface LogSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface LogSearch
extends OsidSearch

The search interface for governing log searches.

Method Summary

Modifier and Type	Method	Description
LogSearchRecord	getLogSearchRecord(Type logSearchRecordType)	Gets the log search record corresponding to the given log search record Type.
void	orderLogResults(LogSearchOrder logSearchOrder)	Specify an ordering to the search results.
void	searchAmongLogs(IdList logIds)	Execute this search among the given list of logs.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongLogs

void searchAmongLogs(IdList logIds)

Execute this search among the given list of logs.

Parameters:

logIds - list of logs

Throws:

NullArgumentException - logIds is null

Compliance:

mandatory - This method must be implemented.

orderLogResults

void orderLogResults(LogSearchOrder logSearchOrder)

Specify an ordering to the search results.

Parameters:

logSearchOrder - log search order

Throws:

NullArgumentException - logSearchOrder is null

UnsupportedException - logSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getLogSearchRecord

LogSearchRecord getLogSearchRecord(Type logSearchRecordType)
                            throws OperationFailedException

Gets the log search 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 record

Throws:

NullArgumentException - logSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.