Interface PoolSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PoolSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PoolQueryInspector	getPoolQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
PoolList	getPools()	Gets the pool list resulting from a search.
PoolSearchResultsRecord	getPoolSearchResultsRecord(Type poolSearchRecordType)	Gets the pool search results record corresponding to the given pool 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

getPools

PoolList getPools()

Gets the pool list resulting from a search.

Returns:

the pool list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getPoolQueryInspector

PoolQueryInspector getPoolQueryInspector()

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

Returns:

the pool query inspector

Compliance:

mandatory - This method must be implemented.

getPoolSearchResultsRecord

PoolSearchResultsRecord getPoolSearchResultsRecord(Type poolSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

poolSearchRecordType - a pool search record type

Returns:

the pool search results record

Throws:

NullArgumentException - poolSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.