org.osid.provisioning.rules

Interface BrokerConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BrokerConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
BrokerConstrainerQueryInspector	getBrokerConstrainerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
BrokerConstrainerList	getBrokerConstrainers() Gets the BrokerConstrainerList resulting from a search.
BrokerConstrainerSearchResultsRecord	getBrokerConstrainerSearchResultsRecord(Type brokerConstrainerSearchRecordType) Gets the broker constrainer search results record corresponding to the given broker constrainer 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

getBrokerConstrainers

BrokerConstrainerList getBrokerConstrainers()

Gets the BrokerConstrainerList resulting from a search.

Returns:

the broker constrainer list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerQueryInspector

BrokerConstrainerQueryInspector getBrokerConstrainerQueryInspector()

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

Returns:

the broker constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerSearchResultsRecord

BrokerConstrainerSearchResultsRecord getBrokerConstrainerSearchResultsRecord(Type brokerConstrainerSearchRecordType)
                                                                             throws OperationFailedException,
                                                                                    PermissionDeniedException

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

Parameters:

brokerConstrainerSearchRecordType - a broker constrainer search record type

Returns:

the broker constrainer search results record

Throws:

NullArgumentException - brokerConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(brokerConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.