Interface BusinessSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BusinessSearch
extends OsidSearch

The search interface for governing business searches.

Method Summary

Modifier and Type	Method	Description
BusinessSearchRecord	getBusinessSearchRecord(Type businessSearchRecordType)	Gets the business search record corresponding to the given business search record Type.
void	orderBusinessResults(BusinessSearchOrder businessSearchOrder)	Specify an ordering to the search results.
void	searchAmongBusinesses(IdList businessIds)	Execute this search among the given list of businesses.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongBusinesses

void searchAmongBusinesses(IdList businessIds)

Execute this search among the given list of businesses.

Parameters:

businessIds - list of businesses

Throws:

NullArgumentException - businessIds is null

Compliance:

mandatory - This method must be implemented.

orderBusinessResults

void orderBusinessResults(BusinessSearchOrder businessSearchOrder)

Specify an ordering to the search results.

Parameters:

businessSearchOrder - business search order

Throws:

NullArgumentException - businessSearchOrder is null

UnsupportedException - businessSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBusinessSearchRecord

BusinessSearchRecord getBusinessSearchRecord(Type businessSearchRecordType)
                                      throws OperationFailedException

Gets the business search 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 record

Throws:

NullArgumentException - businessSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(businessSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.