Interface PoolProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PoolProcessorEnablerSearch
extends OsidSearch

The search interface for governing pool processor enabler searches.

Method Summary

Modifier and Type	Method	Description
PoolProcessorEnablerSearchRecord	getPoolProcessorEnablerSearchRecord(Type poolProcessorEnablerSearchRecordType)	Gets the pool processor enabler search record corresponding to the given pool processor enabler search record Type.
void	orderPoolProcessorEnablerResults(PoolProcessorEnablerSearchOrder poolProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongPoolProcessorEnablers(IdList poolProcessorEnablerIds)	Execute this search among the given list of pool processor 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

searchAmongPoolProcessorEnablers

void searchAmongPoolProcessorEnablers(IdList poolProcessorEnablerIds)

Execute this search among the given list of pool processor enablers.

Parameters:

poolProcessorEnablerIds - list of pool processor enablers

Throws:

NullArgumentException - poolProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderPoolProcessorEnablerResults

void orderPoolProcessorEnablerResults(PoolProcessorEnablerSearchOrder poolProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

poolProcessorEnablerSearchOrder - pool processor enabler search order

Throws:

NullArgumentException - poolProcessorEnablerSearchOrder is null

UnsupportedException - poolProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolProcessorEnablerSearchRecord

PoolProcessorEnablerSearchRecord getPoolProcessorEnablerSearchRecord(Type poolProcessorEnablerSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

poolProcessorEnablerSearchRecordType - a pool processor enabler search record type

Returns:

the pool processor enabler search record

Throws:

NullArgumentException - poolProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.