org.osid.provisioning.rules

Interface BrokerProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BrokerProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
BrokerProcessorQueryInspector	getBrokerProcessorQueryInspector() Gets the inspector for the query to examine the terms used in the search.
BrokerProcessorList	getBrokerProcessors() Gets the BrokerProcessorList resulting from a search.
BrokerProcessorSearchResultsRecord	getBrokerProcessorSearchResultsRecord(Type brokerProcessorSearchRecordType) Gets the broker processor search results record corresponding to the given broker processor 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

getBrokerProcessors

BrokerProcessorList getBrokerProcessors()

Gets the BrokerProcessorList resulting from a search.

Returns:

the broker processor list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorQueryInspector

BrokerProcessorQueryInspector getBrokerProcessorQueryInspector()

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

Returns:

the broker processor query inspector

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorSearchResultsRecord

BrokerProcessorSearchResultsRecord getBrokerProcessorSearchResultsRecord(Type brokerProcessorSearchRecordType)
                                                                         throws OperationFailedException,
                                                                                PermissionDeniedException

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

Parameters:

brokerProcessorSearchRecordType - a broker processor search record type

Returns:

the broker processor search results record

Throws:

NullArgumentException - brokerProcessorSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(brokerProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.