Interface PoolProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PoolProcessorSearch
extends OsidSearch

The search interface for governing pool processor searches.

Method Summary

Modifier and Type	Method	Description
PoolProcessorSearchRecord	getPoolProcessorSearchRecord(Type poolProcessorSearchRecordType)	Gets the pool processor search record corresponding to the given pool processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderPoolProcessorResults(PoolProcessorSearchOrder poolProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongPoolProcessors(IdList poolProcessorIds)	Execute this search among the given list of pool processors.

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

searchAmongPoolProcessors

void searchAmongPoolProcessors(IdList poolProcessorIds)

Execute this search among the given list of pool processors.

Parameters:

poolProcessorIds - list of pool processors

Throws:

NullArgumentException - poolProcessorIds is null

Compliance:

mandatory - This method must be implemented.

orderPoolProcessorResults

void orderPoolProcessorResults(PoolProcessorSearchOrder poolProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

poolProcessorSearchOrder - pool processor search order

Throws:

NullArgumentException - poolProcessorSearchOrder is null

UnsupportedException - poolProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolProcessorSearchRecord

PoolProcessorSearchRecord getPoolProcessorSearchRecord(Type poolProcessorSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

poolProcessorSearchRecordType - a pool processor search record type

Returns:

the pool processor search record

Throws:

NullArgumentException - poolProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.