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

Modifier and Type	Method	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 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

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.