org.osid.provisioning.rules

Interface QueueConstrainerEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface QueueConstrainerEnablerSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

Modifier and Type	Method and Description
QueueConstrainerEnablerQueryInspector	getQueueConstrainerEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
QueueConstrainerEnablerList	getQueueConstrainerEnablers() Gets the QueueConstrainerEnablerList resulting from a search.
QueueConstrainerEnablerSearchResultsRecord	getQueueConstrainerEnablerSearchResultsRecord(Type queueConstrainerEnablerSearchRecordType) Gets the queue constrainer enabler search results record corresponding to the given queue constrainer enabler search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getQueueConstrainerEnablers

QueueConstrainerEnablerList getQueueConstrainerEnablers()

Gets the QueueConstrainerEnablerList resulting from a search.

Returns:

the queue constrainer enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablerQueryInspector

QueueConstrainerEnablerQueryInspector getQueueConstrainerEnablerQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the queue constrainer enabler query inspector

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablerSearchResultsRecord

QueueConstrainerEnablerSearchResultsRecord getQueueConstrainerEnablerSearchResultsRecord(Type queueConstrainerEnablerSearchRecordType)
                                                                                         throws OperationFailedException,
                                                                                                PermissionDeniedException

Gets the queue constrainer enabler search results record corresponding to the given queue constrainer enabler search record Type. This method must be used to retrieve an object implementing the requested record.

Parameters:

queueConstrainerEnablerSearchRecordType - a queue constrainer enabler search record type

Returns:

the queue constrainer enabler search results record

Throws:

NullArgumentException - queueConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(queueConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.