public interface CalendarSearch extends OsidSearch
The interface for governing calendar searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCalendars(IdList calendarIds)
calendarIds
- list of calendarsNullArgumentException
- calendarIds
is
null
mandatory
- This method must be implemented. void orderCalendarResults(CalendarSearchOrder calendarSearchOrder)
calendarSearchOrder
- calendar search orderNullArgumentException
- calendarSearchOrder
is null
UnsupportedException
- calendarSearchOrder
is not of this servicemandatory
- This method must be implemented. CalendarSearchRecord getCalendarSearchRecord(Type calendarSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.calendarSearchRecordType
- a calendar search record typeNullArgumentException
- calendarSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(calendarSearchRecordType)
is
false
mandatory
- This method must be implemented.