Interface CyclicEventSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CyclicEventSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CyclicEventQueryInspector	getCyclicEventQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CyclicEventList	getCyclicEvents()	Gets the cyclic event list resulting from the search.
CyclicEventSearchResultsRecord	getCyclicEventSearchResultsRecord(Type cyclicEventSearchRecordType)	Gets the cyclic event search results record corresponding to the given 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

getCyclicEvents

CyclicEventList getCyclicEvents()

Gets the cyclic event list resulting from the search.

Returns:

the cyclic event list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getCyclicEventQueryInspector

CyclicEventQueryInspector getCyclicEventQueryInspector()

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.

getCyclicEventSearchResultsRecord

CyclicEventSearchResultsRecord getCyclicEventSearchResultsRecord(Type cyclicEventSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

cyclicEventSearchRecordType - a cyclic event search record type

Returns:

the cyclic event search results record

Throws:

NullArgumentException - cyclicEventSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicEventSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.