org.osid.provisioning.rules

Interface BrokerProcessorEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BrokerProcessorEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
BrokerProcessorEnablerQueryInspector	getBrokerProcessorEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
BrokerProcessorEnablerList	getBrokerProcessorEnablers() Gets the BrokerProcessorEnablerList resulting from a search.
BrokerProcessorEnablerSearchResultsRecord	getBrokerProcessorEnablerSearchResultsRecord(Type brokerProcessorEnablerSearchRecordType) Gets the broker processor enabler search results record corresponding to the given broker processor 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

getBrokerProcessorEnablers

BrokerProcessorEnablerList getBrokerProcessorEnablers()

Gets the BrokerProcessorEnablerList resulting from a search.

Returns:

the broker processor enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorEnablerQueryInspector

BrokerProcessorEnablerQueryInspector getBrokerProcessorEnablerQueryInspector()

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

Returns:

the broker processor enabler query inspector

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorEnablerSearchResultsRecord

BrokerProcessorEnablerSearchResultsRecord getBrokerProcessorEnablerSearchResultsRecord(Type brokerProcessorEnablerSearchRecordType)
                                                                                       throws OperationFailedException,
                                                                                              PermissionDeniedException

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

Parameters:

brokerProcessorEnablerSearchRecordType - a broker processor enabler search record type

Returns:

the broker processor enabler search results record

Throws:

NullArgumentException - brokerProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(brokerProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.