public interface BusinessSearch extends OsidSearch
The search interface for governing business searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBusinesses(IdList businessIds)
businessIds
- list of businessesNullArgumentException
- businessIds
is
null
mandatory
- This method must be implemented. void orderBusinessResults(BusinessSearchOrder businessSearchOrder)
businessSearchOrder
- business search orderNullArgumentException
- businessSearchOrder
is null
UnsupportedException
- businessSearchOrder
is not of this servicemandatory
- This method must be implemented. BusinessSearchRecord getBusinessSearchRecord(Type businessSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.businessSearchRecordType
- a business search record typeNullArgumentException
- businessSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(businessSearchRecordType)
is
false
mandatory
- This method must be implemented.