Interface PoolEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PoolEnablerSearch
extends OsidSearch

The search interface for governing pool enabler searches.

Method Summary

Modifier and Type	Method	Description
PoolEnablerSearchRecord	getPoolEnablerSearchRecord(Type poolEnablerSearchRecordType)	Gets the pool enabler search record corresponding to the given pool enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderPoolEnablerResults(PoolEnablerSearchOrder poolEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongPoolEnablers(IdList poolEnablerIds)	Execute this search among the given list of pool enablers.

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

searchAmongPoolEnablers

void searchAmongPoolEnablers(IdList poolEnablerIds)

Execute this search among the given list of pool enablers.

Parameters:

poolEnablerIds - list of pool enablers

Throws:

NullArgumentException - poolEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderPoolEnablerResults

void orderPoolEnablerResults(PoolEnablerSearchOrder poolEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

poolEnablerSearchOrder - pool enabler search order

Throws:

NullArgumentException - poolEnablerSearchOrder is null

UnsupportedException - poolEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolEnablerSearchRecord

PoolEnablerSearchRecord getPoolEnablerSearchRecord(Type poolEnablerSearchRecordType)
                                            throws OperationFailedException

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

Throws:

NullArgumentException - poolEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.