Interface PoolSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PoolSearch
extends OsidSearch

The search interface for governing pool searches.

Method Summary

Modifier and Type	Method	Description
PoolSearchRecord	getPoolSearchRecord(Type poolSearchRecordType)	Gets the pool search record corresponding to the given pool search record Type.
void	orderPoolResults(PoolSearchOrder poolSearchOrder)	Specify an ordering to the search results.
void	searchAmongPools(IdList poolIds)	Execute this search among the given list of pools.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongPools

void searchAmongPools(IdList poolIds)

Execute this search among the given list of pools.

Parameters:

poolIds - list of pools

Throws:

NullArgumentException - poolIds is null

Compliance:

mandatory - This method must be implemented.

orderPoolResults

void orderPoolResults(PoolSearchOrder poolSearchOrder)

Specify an ordering to the search results.

Parameters:

poolSearchOrder - pool search order

Throws:

NullArgumentException - poolSearchOrder is null

UnsupportedException - poolSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolSearchRecord

PoolSearchRecord getPoolSearchRecord(Type poolSearchRecordType)
                              throws OperationFailedException

Gets the pool search 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 record

Throws:

NullArgumentException - poolSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.