Interface BusinessSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BusinessSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BusinessList	getBusinesses()	Gets the business list resulting from a search.
BusinessQueryInspector	getBusinessQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BusinessSearchResultsRecord	getBusinessSearchResultsRecord(Type businessSearchRecordType)	Gets the business search results record corresponding to the given business 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

getBusinesses

BusinessList getBusinesses()

Gets the business list resulting from a search.

Returns:

the business list

Throws:

IllegalStateException - the business list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBusinessQueryInspector

BusinessQueryInspector getBusinessQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getBusinessSearchResultsRecord

BusinessSearchResultsRecord getBusinessSearchResultsRecord(Type businessSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

businessSearchRecordType - a business search record type

Returns:

the business search results record

Throws:

NullArgumentException - businessSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(businessSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.