Interface RecurringEventSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RecurringEventSearch
extends OsidSearch

RecurringEventSearch defines the interface for specifying recurring event search options.

Method Summary

Modifier and Type	Method	Description
RecurringEventSearchRecord	getRecurringEventSearchRecord(Type recurringEventSearchRecordType)	Gets the recurring event record corresponding to the given recurring event search record Type .
void	orderRecurringEventResults(RecurringEventSearchOrder recurringEventSearchOrder)	Specify an ordering to the search results.
void	searchAmongRecurringEvents(IdList recurringEventIds)	Execute this search among the given list of recurring 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

searchAmongRecurringEvents

void searchAmongRecurringEvents(IdList recurringEventIds)

Execute this search among the given list of recurring events.

Parameters:

recurringEventIds - list of recurring events

Throws:

NullArgumentException - recurringEventIds is null

Compliance:

mandatory - This method must be implemented.

orderRecurringEventResults

void orderRecurringEventResults(RecurringEventSearchOrder recurringEventSearchOrder)

Specify an ordering to the search results.

Parameters:

recurringEventSearchOrder - recurring event search order

Throws:

NullArgumentException - recurringEventSearchOrder is null

UnsupportedException - recurringEventSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRecurringEventSearchRecord

RecurringEventSearchRecord getRecurringEventSearchRecord(Type recurringEventSearchRecordType)
                                                  throws OperationFailedException

Gets the recurring event record corresponding to the given recurring event search record Type .

Parameters:

recurringEventSearchRecordType - a recurring event search record type

Returns:

the recurring event search record

Throws:

NullArgumentException - recurringEventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(recurringEventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.