public interface CalendarSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
CalendarQueryInspector |
getCalendarQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
CalendarList |
getCalendars()
Gets the calendar list resulting from the search.
|
CalendarSearchResultsRecord |
getCalendarSearchResultsRecord(Type calendarSearchRecordType)
Gets the calendar search results record corresponding to the given
calendar search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
CalendarList getCalendars()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. CalendarQueryInspector getCalendarQueryInspector()
mandatory
- This method must be implemented. CalendarSearchResultsRecord getCalendarSearchResultsRecord(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.