Interface PoolEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PoolEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PoolEnablerQueryInspector	getPoolEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
PoolEnablerList	getPoolEnablers()	Gets the pool enabler list resulting from a search.
PoolEnablerSearchResultsRecord	getPoolEnablerSearchResultsRecord(Type poolEnablerSearchRecordType)	Gets the pool enabler search results record corresponding to the given pool enabler 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

getPoolEnablers

PoolEnablerList getPoolEnablers()

Gets the pool enabler list resulting from a search.

Returns:

the pool enabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getPoolEnablerQueryInspector

PoolEnablerQueryInspector getPoolEnablerQueryInspector()

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

Returns:

the pool enabler query inspector

Compliance:

mandatory - This method must be implemented.

getPoolEnablerSearchResultsRecord

PoolEnablerSearchResultsRecord getPoolEnablerSearchResultsRecord(Type poolEnablerSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

poolEnablerSearchRecordType - a pool enabler search record type

Returns:

the pool enabler search results record

Throws:

NullArgumentException - poolEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.