public interface PoolProcessorSearch extends OsidSearch
The search interface for governing pool processor searches.
Modifier and Type | Method and Description |
---|---|
PoolProcessorSearchRecord |
getPoolProcessorSearchRecord(Type poolProcessorSearchRecordType)
Gets the pool processor search record corresponding to the given pool
processor search record
Type. |
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongPoolProcessors(IdList poolProcessorIds)
poolProcessorIds
- list of pool processorsNullArgumentException
- poolProcessorIds
is null
mandatory
- This method must be implemented. void orderPoolProcessorResults(PoolProcessorSearchOrder poolProcessorSearchOrder)
poolProcessorSearchOrder
- pool processor search orderNullArgumentException
- poolProcessorSearchOrder
is null
UnsupportedException
- poolProcessorSearchOrder
is not of this servicemandatory
- This method must be implemented. PoolProcessorSearchRecord getPoolProcessorSearchRecord(Type poolProcessorSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.poolProcessorSearchRecordType
- a pool processor search record
typeNullArgumentException
-
poolProcessorSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(poolProcessorSearchRecordType)
is
false
mandatory
- This method must be implemented.