Interface PoolConstrainerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PoolConstrainerEnablerSearch
extends OsidSearch

The search interface for governing pool constrainer enabler searches.

Method Summary

Modifier and Type	Method	Description
PoolConstrainerEnablerSearchRecord	getPoolConstrainerEnablerSearchRecord(Type poolConstrainerEnablerSearchRecordType)	Gets the pool constrainer enabler search record corresponding to the given pool constrainer enabler search record Type.
void	orderPoolConstrainerEnablerResults(PoolConstrainerEnablerSearchOrder poolConstrainerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongPoolConstrainerEnablers(IdList poolConstrainerEnablerIds)	Execute this search among the given list of pool constrainer 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

searchAmongPoolConstrainerEnablers

void searchAmongPoolConstrainerEnablers(IdList poolConstrainerEnablerIds)

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

Parameters:

poolConstrainerEnablerIds - list of pool constrainer enablers

Throws:

NullArgumentException - poolConstrainerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderPoolConstrainerEnablerResults

void orderPoolConstrainerEnablerResults(PoolConstrainerEnablerSearchOrder poolConstrainerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

poolConstrainerEnablerSearchOrder - pool constrainer enabler search order

Throws:

NullArgumentException - poolConstrainerEnablerSearchOrder is null

UnsupportedException - poolConstrainerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerEnablerSearchRecord

PoolConstrainerEnablerSearchRecord getPoolConstrainerEnablerSearchRecord(Type poolConstrainerEnablerSearchRecordType)
                                                                  throws OperationFailedException

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

Parameters:

poolConstrainerEnablerSearchRecordType - a pool constrainer enabler search record type

Returns:

the pool constrainer enabler search record

Throws:

NullArgumentException - poolConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.