public interface PoolConstrainerSearch extends OsidSearch
The search interface for governing pool constrainer searches.
Modifier and Type | Method and Description |
---|---|
PoolConstrainerSearchRecord |
getPoolConstrainerSearchRecord(Type poolConstrainerSearchRecordType)
Gets the pool constrainer search record corresponding to the given
pool constrainer search record
Type. |
void |
orderPoolConstrainerResults(PoolConstrainerSearchOrder poolConstrainerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongPoolConstrainers(IdList distributorIds)
Execute this search among the given list of pool constrainers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongPoolConstrainers(IdList distributorIds)
distributorIds
- list of pool constrainersNullArgumentException
- distributorIds
is null
mandatory
- This method must be implemented. void orderPoolConstrainerResults(PoolConstrainerSearchOrder poolConstrainerSearchOrder)
poolConstrainerSearchOrder
- pool constrainer search orderNullArgumentException
-
poolConstrainerSearchOrder
is null
UnsupportedException
-
poolConstrainerSearchOrder
is not of this servicemandatory
- This method must be implemented. PoolConstrainerSearchRecord getPoolConstrainerSearchRecord(Type poolConstrainerSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.poolConstrainerSearchRecordType
- a pool constrainer search
record typeNullArgumentException
-
poolConstrainerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(poolConstrainerSearchRecordType)
is
false
mandatory
- This method must be implemented.