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

Modifier and Type	Method	Description
BrokerConstrainerQueryInspector	getBrokerConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BrokerConstrainerList	getBrokerConstrainers()	Gets the broker constrainer list 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 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

getBrokerConstrainers

BrokerConstrainerList getBrokerConstrainers()

Gets the broker constrainer list resulting from a search.

Returns:

the broker constrainer list

Throws:

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

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

UnsupportedException - hasRecordType(brokerConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.