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

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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.