Interface QueueProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface QueueProcessorSearch
extends OsidSearch

The search interface for governing queue processor searches.

Method Summary

Modifier and Type	Method	Description
QueueProcessorSearchRecord	getQueueProcessorSearchRecord(Type queueProcessorSearchRecordType)	Gets the queue processor search record corresponding to the given queue processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderQueueProcessorResults(QueueProcessorSearchOrder queueProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongQueueProcessors(IdList queueProcessorIds)	Execute this search among the given list of queue processors.

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

searchAmongQueueProcessors

void searchAmongQueueProcessors(IdList queueProcessorIds)

Execute this search among the given list of queue processors.

Parameters:

queueProcessorIds - list of queue processors

Throws:

NullArgumentException - queueProcessorIds is null

Compliance:

mandatory - This method must be implemented.

orderQueueProcessorResults

void orderQueueProcessorResults(QueueProcessorSearchOrder queueProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

queueProcessorSearchOrder - queue processor search order

Throws:

NullArgumentException - queueProcessorSearchOrder is null

UnsupportedException - queueProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getQueueProcessorSearchRecord

QueueProcessorSearchRecord getQueueProcessorSearchRecord(Type queueProcessorSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

queueProcessorSearchRecordType - a queue processor search record type

Returns:

the queue processor search record

Throws:

NullArgumentException - queueProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.