org.osid.calendaring

Interface CalendarSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CalendarSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getCalendars

CalendarList getCalendars()

Gets the calendar list resulting from the search.

Returns:

the calendar list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getCalendarQueryInspector

CalendarQueryInspector getCalendarQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the calendar query inspector

Compliance:

mandatory - This method must be implemented.

getCalendarSearchResultsRecord

CalendarSearchResultsRecord getCalendarSearchResultsRecord(Type calendarSearchRecordType)
                                                           throws OperationFailedException

Gets the calendar search results 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 results record

Throws:

NullArgumentException - calendarSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(calendarSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.