Interface LogEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface LogEntrySearch
extends OsidSearch

The search interface for governing log entry searches.

Method Summary

Modifier and Type	Method	Description
LogEntrySearchRecord	getLogEntrySearchRecord(Type logEntrySearchRecordType)	Gets the log search record corresponding to the given log entry search record Type.
void	orderLogEntryResults(LogEntrySearchOrder logEntrySearchOrder)	Specify an ordering to the search results.
void	searchAmongLogEntries(IdList logEntryIds)	Execute this search among the given list of log entries.

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

searchAmongLogEntries

void searchAmongLogEntries(IdList logEntryIds)

Execute this search among the given list of log entries.

Parameters:

logEntryIds - list of log entries

Throws:

NullArgumentException - logEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderLogEntryResults

void orderLogEntryResults(LogEntrySearchOrder logEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

logEntrySearchOrder - log entry search order

Throws:

NullArgumentException - logEntrySearchOrder is null

UnsupportedException - logEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getLogEntrySearchRecord

LogEntrySearchRecord getLogEntrySearchRecord(Type logEntrySearchRecordType)
                                      throws OperationFailedException

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

Throws:

NullArgumentException - logEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.