Interface QueueProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface QueueProcessorEnablerSearch
extends OsidSearch

The search interface for governing queue processor enabler searches.

Method Summary

Modifier and Type	Method	Description
QueueProcessorEnablerSearchRecord	getQueueProcessorEnablerSearchRecord(Type queueProcessorEnablerSearchRecordType)	Gets the queue processor enabler search record corresponding to the given queue processor enabler search record Type .
void	orderQueueProcessorEnablerResults(QueueProcessorEnablerSearchOrder queueProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongQueueProcessorEnablers(IdList queueProcessorEnablerIds)	Execute this search among the given list of queue processor 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

searchAmongQueueProcessorEnablers

void searchAmongQueueProcessorEnablers(IdList queueProcessorEnablerIds)

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

Parameters:

queueProcessorEnablerIds - list of queue processor enablers

Throws:

NullArgumentException - queueProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderQueueProcessorEnablerResults

void orderQueueProcessorEnablerResults(QueueProcessorEnablerSearchOrder queueProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

queueProcessorEnablerSearchOrder - queue processor enabler search order

Throws:

NullArgumentException - queueProcessorEnablerSearchOrder is null

UnsupportedException - queueProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablerSearchRecord

QueueProcessorEnablerSearchRecord getQueueProcessorEnablerSearchRecord(Type queueProcessorEnablerSearchRecordType)
                                                                throws OperationFailedException

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

Parameters:

queueProcessorEnablerSearchRecordType - a queue processor enabler search record type

Returns:

the queue processor enabler search record

Throws:

NullArgumentException - queueProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.