Interface CalendarSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CalendarSearch
extends OsidSearch

The interface for governing calendar searches.

Method Summary

Modifier and Type	Method	Description
CalendarSearchRecord	getCalendarSearchRecord(Type calendarSearchRecordType)	Gets the calendar search record corresponding to the given calendar search record Type .
void	orderCalendarResults(CalendarSearchOrder calendarSearchOrder)	Specify an ordering to the search results.
void	searchAmongCalendars(IdList calendarIds)	Execute this search among the given list of calendars.

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

searchAmongCalendars

void searchAmongCalendars(IdList calendarIds)

Execute this search among the given list of calendars.

Parameters:

calendarIds - list of calendars

Throws:

NullArgumentException - calendarIds is null

Compliance:

mandatory - This method must be implemented.

orderCalendarResults

void orderCalendarResults(CalendarSearchOrder calendarSearchOrder)

Specify an ordering to the search results.

Parameters:

calendarSearchOrder - calendar search order

Throws:

NullArgumentException - calendarSearchOrder is null

UnsupportedException - calendarSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCalendarSearchRecord

CalendarSearchRecord getCalendarSearchRecord(Type calendarSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

calendarSearchRecordType - a calendar search record type

Returns:

the calendar search interface

Throws:

NullArgumentException - calendarSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(calendarSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.