org.osid.provisioning.rules

Interface BrokerConstrainerEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BrokerConstrainerEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
BrokerConstrainerEnablerQueryInspector	getBrokerConstrainerEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
BrokerConstrainerEnablerList	getBrokerConstrainerEnablers() Gets the BrokerConstrainerEnablerList resulting from a search.
BrokerConstrainerEnablerSearchResultsRecord	getBrokerConstrainerEnablerSearchResultsRecord(Type brokerConstrainerEnablerSearchRecordType) Gets the broker constrainer enabler search results record corresponding to the given broker 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

getBrokerConstrainerEnablers

BrokerConstrainerEnablerList getBrokerConstrainerEnablers()

Gets the BrokerConstrainerEnablerList resulting from a search.

Returns:

the broker constrainer enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablerQueryInspector

BrokerConstrainerEnablerQueryInspector getBrokerConstrainerEnablerQueryInspector()

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

Returns:

the broker constrainer enabler query inspector

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablerSearchResultsRecord

BrokerConstrainerEnablerSearchResultsRecord getBrokerConstrainerEnablerSearchResultsRecord(Type brokerConstrainerEnablerSearchRecordType)
                                                                                           throws OperationFailedException,
                                                                                                  PermissionDeniedException

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

Parameters:

brokerConstrainerEnablerSearchRecordType - a broker constrainer enabler search record type

Returns:

the broker constrainer enabler search results record

Throws:

NullArgumentException - brokerConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(brokerConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.