org.osid.calendaring

Interface EventSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface EventSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
EventQueryInspector	getEventQueryInspector() Gets the inspector for the query to examine the terms used in the search.
EventList	getEvents() Gets the event list resulting from the search.
EventSearchResultsRecord	getEventSearchResultsRecord(Type eventSearchRecordType) Gets the event search results record corresponding to the given event 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

getEvents

EventList getEvents()

Gets the event list resulting from the search.

Returns:

the event list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getEventQueryInspector

EventQueryInspector getEventQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getEventSearchResultsRecord

EventSearchResultsRecord getEventSearchResultsRecord(Type eventSearchRecordType)
                                                     throws OperationFailedException

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

Parameters:

eventSearchRecordType - an event search record type

Returns:

the event search results record

Throws:

NullArgumentException - eventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(eventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.