Interface BuildingSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BuildingSearch
extends OsidSearch

The search interface for governing building searches.

Method Summary

Modifier and Type	Method	Description
BuildingSearchRecord	getBuildingSearchRecord(Type buildingSearchRecordType)	Gets the building search record corresponding to the given building search record Type .
void	orderBuildingResults(BuildingSearchOrder buildingSearchOrder)	Specify an ordering to the search results.
void	searchAmongBuildings(IdList buildingIds)	Execute this search among the given list of buildings.

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

searchAmongBuildings

void searchAmongBuildings(IdList buildingIds)

Execute this search among the given list of buildings.

Parameters:

buildingIds - list of buildings

Throws:

NullArgumentException - buildingIds is null

Compliance:

mandatory - This method must be implemented.

orderBuildingResults

void orderBuildingResults(BuildingSearchOrder buildingSearchOrder)

Specify an ordering to the search results.

Parameters:

buildingSearchOrder - building search order

Throws:

NullArgumentException - buildingSearchOrder is null

UnsupportedException - buildingSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBuildingSearchRecord

BuildingSearchRecord getBuildingSearchRecord(Type buildingSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

buildingSearchRecordType - a building search record type

Returns:

the building search record

Throws:

NullArgumentException - buildingSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(buildingSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.