Interface BrokerEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BrokerEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BrokerEnablerQueryInspector	getBrokerEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BrokerEnablerList	getBrokerEnablers()	Gets the broker enabler list resulting from a search.
BrokerEnablerSearchResultsRecord	getBrokerEnablerSearchResultsRecord(Type brokerEnablerSearchRecordType)	Gets the broker enabler search results record corresponding to the given broker enabler search record Type .This method is used to retrieve an object implementing the requested record.

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

getBrokerEnablers

BrokerEnablerList getBrokerEnablers()

Gets the broker enabler list resulting from a search.

Returns:

the broker enabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getBrokerEnablerQueryInspector

BrokerEnablerQueryInspector getBrokerEnablerQueryInspector()

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

Returns:

the broker enabler query inspector

Compliance:

mandatory - This method must be implemented.

getBrokerEnablerSearchResultsRecord

BrokerEnablerSearchResultsRecord getBrokerEnablerSearchResultsRecord(Type brokerEnablerSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

brokerEnablerSearchRecordType - a broker enabler search record type

Returns:

the broker enabler search results record

Throws:

NullArgumentException - brokerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.