org.osid.calendaring

Interface SupersedingEventSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SupersedingEventSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
SupersedingEventQueryInspector	getSupersedingEventQueryInspector() Gets the inspector for the query to examine the terms used in the search.
SupersedingEventList	getSupersedingEvents() Gets the superseding event list resulting from the search.
SupersedingEventSearchResultsRecord	getSupersedingEventSearchResultsRecord(Type supersedingEventSearchRecordType) Gets the superseding event search results record corresponding to the given superseding 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

getSupersedingEvents

SupersedingEventList getSupersedingEvents()

Gets the superseding event list resulting from the search.

Returns:

the superseding event list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getSupersedingEventQueryInspector

SupersedingEventQueryInspector getSupersedingEventQueryInspector()

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.

getSupersedingEventSearchResultsRecord

SupersedingEventSearchResultsRecord getSupersedingEventSearchResultsRecord(Type supersedingEventSearchRecordType)
                                                                           throws OperationFailedException

Gets the superseding event search results record corresponding to the given superseding event search record Type.

Parameters:

supersedingEventSearchRecordType - a superseding event search record type

Returns:

the superseding event search results record

Throws:

NullArgumentException - supersedingEventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(supersedingEventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.