org.osid.provisioning.rules

Interface QueueConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface QueueConstrainerSearch
extends OsidSearch

The search interface for governing queue constrainer searches.

Method Summary

Methods

Modifier and Type	Method and Description
QueueConstrainerSearchRecord	getQueueConstrainerSearchRecord(Type queueConstrainerSearchRecordType) Gets the queue constrainer search record corresponding to the given queue constrainer search record Type.
void	orderQueueConstrainerResults(QueueConstrainerSearchOrder queueConstrainerSearchOrder) Specify an ordering to the search results.
void	searchAmongQueueConstrainers(IdList distributorIds) Execute this search among the given list of queue constrainers.

Methods inherited from interface org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

searchAmongQueueConstrainers

void searchAmongQueueConstrainers(IdList distributorIds)

Execute this search among the given list of queue constrainers.

Parameters:

distributorIds - list of queue constrainers

Throws:

NullArgumentException - distributorIds is null

Compliance:

mandatory - This method must be implemented.

orderQueueConstrainerResults

void orderQueueConstrainerResults(QueueConstrainerSearchOrder queueConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

queueConstrainerSearchOrder - queue constrainer search order

Throws:

NullArgumentException - queueConstrainerSearchOrder is null

UnsupportedException - queueConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerSearchRecord

QueueConstrainerSearchRecord getQueueConstrainerSearchRecord(Type queueConstrainerSearchRecordType)
                                                             throws OperationFailedException

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

Parameters:

queueConstrainerSearchRecordType - a queue constrainer search record type

Returns:

the queue constrainer search record

Throws:

NullArgumentException - queueConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.