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

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

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.