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

Modifier and Type	Method	Description
BrokerProcessorEnablerQueryInspector	getBrokerProcessorEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BrokerProcessorEnablerList	getBrokerProcessorEnablers()	Gets the broker processor enabler list 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 Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getBrokerProcessorEnablers

BrokerProcessorEnablerList getBrokerProcessorEnablers()

Gets the broker processor enabler list resulting from a search.

Returns:

the broker processor enabler list

Throws:

IllegalStateException - list already 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

Gets the broker processor enabler search results record corresponding to the given broker processor enabler search record Type . This method is 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

UnsupportedException - hasRecordType(brokerProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.