Interface PoolConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PoolConstrainerSearch
extends OsidSearch

The search interface for governing pool constrainer searches.

Method Summary

Modifier and Type	Method	Description
PoolConstrainerSearchRecord	getPoolConstrainerSearchRecord(Type poolConstrainerSearchRecordType)	Gets the pool constrainer search record corresponding to the given pool constrainer search record Type .This method is used to retrieve an object implementing the requested record.
void	orderPoolConstrainerResults(PoolConstrainerSearchOrder poolConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongPoolConstrainers(IdList poolConstrainerIds)	Execute this search among the given list of pool constrainers.

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

searchAmongPoolConstrainers

void searchAmongPoolConstrainers(IdList poolConstrainerIds)

Execute this search among the given list of pool constrainers.

Parameters:

poolConstrainerIds - list of pool constrainer

Throws:

NullArgumentException - poolConstrainerIds is null

Compliance:

mandatory - This method must be implemented.

orderPoolConstrainerResults

void orderPoolConstrainerResults(PoolConstrainerSearchOrder poolConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

poolConstrainerSearchOrder - pool constrainer search order

Throws:

NullArgumentException - poolConstrainerSearchOrder is null

UnsupportedException - poolConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerSearchRecord

PoolConstrainerSearchRecord getPoolConstrainerSearchRecord(Type poolConstrainerSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

poolConstrainerSearchRecordType - a pool constrainer search record type

Returns:

the pool constrainer search record

Throws:

NullArgumentException - poolConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.