org.osid.calendaring.rules

Interface OffsetEventEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface OffsetEventEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
OffsetEventEnablerQueryInspector	getOffsetEventEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
OffsetEventEnablerList	getOffsetEventEnablers() Gets the OffsetEventEnablerList resulting from a search.
OffsetEventEnablerSearchResultsRecord	getOffsetEventEnablerSearchResultsRecord(Type offsetEventEnablerSearchRecordType) Gets the offset event enabler search results record corresponding to the given offset event enabler 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

getOffsetEventEnablers

OffsetEventEnablerList getOffsetEventEnablers()

Gets the OffsetEventEnablerList resulting from a search.

Returns:

the offset event enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablerQueryInspector

OffsetEventEnablerQueryInspector getOffsetEventEnablerQueryInspector()

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

Returns:

the offset event enabler query inspector

Compliance:

mandatory - This method must be implemented.

getOffsetEventEnablerSearchResultsRecord

OffsetEventEnablerSearchResultsRecord getOffsetEventEnablerSearchResultsRecord(Type offsetEventEnablerSearchRecordType)
                                                                               throws OperationFailedException,
                                                                                      PermissionDeniedException

Gets the offset event enabler search results record corresponding to the given offset event enabler search record Type. This method must be used to retrieve an object implementing the requested record.

Parameters:

offsetEventEnablerSearchRecordType - an offset event enabler search record type

Returns:

the offset event enabler search results record

Throws:

NullArgumentException - offsetEventEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(offsetEventEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.