Interface CyclicEventSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CyclicEventSearch
extends OsidSearch

EventSearch defines the interface for specifying event search options.

Method Summary

Modifier and Type	Method	Description
CyclicEventSearchRecord	getCyclicEventSearchRecord(Type cyclicEventSearchRecordType)	Gets the cyclic event search record corresponding to the given event search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCyclicEventResults(CyclicEventSearchOrder cyclicEventSearchOrder)	Specify an ordering to the search results.
void	searchAmongCyclicEvents(IdList cyclicEventIds)	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

searchAmongCyclicEvents

void searchAmongCyclicEvents(IdList cyclicEventIds)

Execute this search among the given list of events.

Parameters:

cyclicEventIds - list of events

Throws:

NullArgumentException - cyclicEventIds is null

Compliance:

mandatory - This method must be implemented.

orderCyclicEventResults

void orderCyclicEventResults(CyclicEventSearchOrder cyclicEventSearchOrder)

Specify an ordering to the search results.

Parameters:

cyclicEventSearchOrder - event search order

Throws:

NullArgumentException - cyclicEventSearchOrder is null

UnsupportedException - cyclicEventSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCyclicEventSearchRecord

CyclicEventSearchRecord getCyclicEventSearchRecord(Type cyclicEventSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

cyclicEventSearchRecordType - a cyclic event search record type

Returns:

the cyclic event search record

Throws:

NullArgumentException - cyclicEventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicEventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.