Interface EventSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface EventSearch
extends OsidSearch

EventSearch defines the interface for specifying event search options.

Method Summary

Modifier and Type	Method	Description
EventSearchRecord	getEventSearchRecord(Type eventSearchRecordType)	Gets the event search record corresponding to the given event search record Type .
void	orderEventResults(EventSearchOrder eventSearchOrder)	Specify an ordering to the search results.
void	searchAmongEvents(IdList eventIds)	Execute this search among the given list of events.

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

searchAmongEvents

void searchAmongEvents(IdList eventIds)

Execute this search among the given list of events.

Parameters:

eventIds - list of events

Throws:

NullArgumentException - eventIds is null

Compliance:

mandatory - This method must be implemented.

orderEventResults

void orderEventResults(EventSearchOrder eventSearchOrder)

Specify an ordering to the search results.

Parameters:

eventSearchOrder - event search order

Throws:

NullArgumentException - eventSearchOrder is null

UnsupportedException - eventSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getEventSearchRecord

EventSearchRecord getEventSearchRecord(Type eventSearchRecordType)
                                throws OperationFailedException

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

Parameters:

eventSearchRecordType - an event search record type

Returns:

the event search record

Throws:

NullArgumentException - eventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(eventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.