Interface BuildingSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BuildingSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BuildingQueryInspector	getBuildingQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
BuildingList	getBuildings()	Gets the building list resulting from a search.
BuildingSearchResultsRecord	getBuildingSearchResultsRecord(Type buildingSearchRecordType)	Gets the building search results record corresponding to the given building 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

getBuildings

BuildingList getBuildings()

Gets the building list resulting from a search.

Returns:

the building list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBuildingQueryInspector

BuildingQueryInspector getBuildingQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getBuildingSearchResultsRecord

BuildingSearchResultsRecord getBuildingSearchResultsRecord(Type buildingSearchRecordType)
                                                    throws OperationFailedException

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

Throws:

NullArgumentException - BuildingSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(buildingSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.