Interface RecurringEventSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RecurringEventSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RecurringEventQueryInspector	getRecurringEventQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RecurringEventList	getRecurringEvents()	Gets the recurring event list resulting from the search.
RecurringEventSearchResultsRecord	getRecurringEventSearchResultsRecord(Type recurringEventSearchRecordType)	Gets the recurring event search results record corresponding to the given recurring event search record Type .This method is used to retrieve an object implementing the requested record.

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

getRecurringEvents

RecurringEventList getRecurringEvents()

Gets the recurring event list resulting from the search.

Returns:

the recurring event list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRecurringEventQueryInspector

RecurringEventQueryInspector getRecurringEventQueryInspector()

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.

getRecurringEventSearchResultsRecord

RecurringEventSearchResultsRecord getRecurringEventSearchResultsRecord(Type recurringEventSearchRecordType)
                                                                throws OperationFailedException

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

Parameters:

recurringEventSearchRecordType - a recurring event search record type

Returns:

the recurring event search results record

Throws:

NullArgumentException - recurringEventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(recurringEventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.