Interface QueueEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface QueueEnablerSearch
extends OsidSearch

The search interface for governing queue enabler searches.

Method Summary

Modifier and Type	Method	Description
QueueEnablerSearchRecord	getQueueEnablerSearchRecord(Type queueEnablerSearchRecordType)	Gets the queue enabler search record corresponding to the given queue enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderQueueEnablerResults(QueueEnablerSearchOrder queueEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongQueueEnablers(IdList queueEnablerIds)	Execute this search among the given list of queue 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

searchAmongQueueEnablers

void searchAmongQueueEnablers(IdList queueEnablerIds)

Execute this search among the given list of queue enablers.

Parameters:

queueEnablerIds - list of queue enablers

Throws:

NullArgumentException - queueEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderQueueEnablerResults

void orderQueueEnablerResults(QueueEnablerSearchOrder queueEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

queueEnablerSearchOrder - queue enabler search order

Throws:

NullArgumentException - queueEnablerSearchOrder is null

UnsupportedException - queueEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getQueueEnablerSearchRecord

QueueEnablerSearchRecord getQueueEnablerSearchRecord(Type queueEnablerSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

queueEnablerSearchRecordType - a queue enabler search record type

Returns:

the queue enabler search record

Throws:

NullArgumentException - queueEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.