Interface QueueConstrainerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface QueueConstrainerEnablerSearch
extends OsidSearch

The search interface for governing queue constrainer enabler searches.

Method Summary

Modifier and Type	Method	Description
QueueConstrainerEnablerSearchRecord	getQueueConstrainerEnablerSearchRecord(Type queueConstrainerEnablerSearchRecordType)	Gets the queue constrainer enabler search record corresponding to the given queue constrainer enabler search record Type.
void	orderQueueConstrainerEnablerResults(QueueConstrainerEnablerSearchOrder queueConstrainerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongQueueConstrainerEnablers(IdList queueConstrainerEnablerIds)	Execute this search among the given list of queue 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

searchAmongQueueConstrainerEnablers

void searchAmongQueueConstrainerEnablers(IdList queueConstrainerEnablerIds)

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

Parameters:

queueConstrainerEnablerIds - list of queue constrainer enablers

Throws:

NullArgumentException - queueConstrainerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderQueueConstrainerEnablerResults

void orderQueueConstrainerEnablerResults(QueueConstrainerEnablerSearchOrder queueConstrainerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

queueConstrainerEnablerSearchOrder - queue constrainer enabler search order

Throws:

NullArgumentException - queueConstrainerEnablerSearchOrder is null

UnsupportedException - queueConstrainerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablerSearchRecord

QueueConstrainerEnablerSearchRecord getQueueConstrainerEnablerSearchRecord(Type queueConstrainerEnablerSearchRecordType)
                                                                    throws OperationFailedException

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

Parameters:

queueConstrainerEnablerSearchRecordType - a queue constrainer enabler search record type

Returns:

the queue constrainer enabler search record

Throws:

NullArgumentException - queueConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.