org.osid.calendaring

Interface OffsetEventSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface OffsetEventSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
OffsetEventQueryInspector	getOffsetEventQueryInspector() Gets the inspector for the query to examine the terms used in the search.
OffsetEventList	getOffsetEvents() Gets the offset event list resulting from the search.
OffsetEventSearchResultsRecord	getOffsetEventSearchResultsRecord(Type offsetEventSearchRecordType) Gets the offset event search results record corresponding to the given offset 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

getOffsetEvents

OffsetEventList getOffsetEvents()

Gets the offset event list resulting from the search.

Returns:

the offset event list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getOffsetEventQueryInspector

OffsetEventQueryInspector getOffsetEventQueryInspector()

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.

getOffsetEventSearchResultsRecord

OffsetEventSearchResultsRecord getOffsetEventSearchResultsRecord(Type offsetEventSearchRecordType)
                                                                 throws OperationFailedException

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

Parameters:

offsetEventSearchRecordType - an offset event search record type

Returns:

the offset event search results record

Throws:

NullArgumentException - offsetEventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offsetEventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.