Interface QueueSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface QueueSearch
extends OsidSearch

The search interface for governing queue searches.

Method Summary

Modifier and Type	Method	Description
QueueSearchRecord	getQueueSearchRecord(Type queueSearchRecordType)	Gets the queue search record corresponding to the given queue search record Type .
void	orderQueueResults(QueueSearchOrder queueSearchOrder)	Specify an ordering to the search results.
void	searchAmongQueues(IdList queueIds)	Execute this search among the given list of queues.

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

searchAmongQueues

void searchAmongQueues(IdList queueIds)

Execute this search among the given list of queues.

Parameters:

queueIds - list of queues

Throws:

NullArgumentException - queueIds is null

Compliance:

mandatory - This method must be implemented.

orderQueueResults

void orderQueueResults(QueueSearchOrder queueSearchOrder)

Specify an ordering to the search results.

Parameters:

queueSearchOrder - queue search order

Throws:

NullArgumentException - queueSearchOrder is null

UnsupportedException - queueSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getQueueSearchRecord

QueueSearchRecord getQueueSearchRecord(Type queueSearchRecordType)
                                throws OperationFailedException

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

Parameters:

queueSearchRecordType - a queue search record type

Returns:

the queue search record

Throws:

NullArgumentException - queueSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.