Interface RecurringEventEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RecurringEventEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RecurringEventEnablerQueryInspector	getRecurringEventEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RecurringEventEnablerList	getRecurringEventEnablers()	Gets the RecurringEventEnablerList resulting from a search.
RecurringEventEnablerSearchResultsRecord	getRecurringEventEnablerSearchResultsRecord(Type recurringEventEnablerSearchRecordType)	Gets the recurring event enabler search results record corresponding to the given recurring event enabler search record Type.

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

getRecurringEventEnablers

RecurringEventEnablerList getRecurringEventEnablers()

Gets the RecurringEventEnablerList resulting from a search.

Returns:

the recurring event enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerQueryInspector

RecurringEventEnablerQueryInspector getRecurringEventEnablerQueryInspector()

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

Returns:

the recurring event enabler query inspector

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerSearchResultsRecord

RecurringEventEnablerSearchResultsRecord getRecurringEventEnablerSearchResultsRecord(Type recurringEventEnablerSearchRecordType)
                                                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

recurringEventEnablerSearchRecordType - a recurring event enabler search record type

Returns:

the recurring event enabler search results record

Throws:

NullArgumentException - recurringEventEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(recurringEventEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.