OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.BuildingSearchSession
Implementsosid.room.BuildingQuerySession
Used Byosid.room.RoomManager
osid.room.RoomProxyManager
Description

This session provides methods for searching Buildings. The search query is constructed using the BuildingQuery. The building record Type also specifies the record for the building query.

getBuildingsByQuery() is the basic search method and returns a list of Building elements. A more advanced search may be performed with getBuildingsBySearch().It accepts a BuildingSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBuildingsBySearch() returns a BuildingSearchResults that can be used to access the resulting BuildingList or be used to perform a search within the result set through BuildingSearch.

Buildings may have a query record indicated by their respective record types. The query record is accessed via the BuildingQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetBuildingSearch
Description

Gets a building search.

Returnosid.room.BuildingSearch the building search
Compliancemandatory This method must be implemented.
MethodgetBuildingSearchOrder
Description

Gets a building search order. The BuildingSearchOrder is supplied to a BuildingSearch to specify the ordering of results.

Returnosid.room.BuildingSearchOrder the building search order
Compliancemandatory This method must be implemented.
MethodgetBuildingsBySearch
Description

Gets the search results matching the given search.

Parametersosid.room.BuildingQuerybuildingQuery the building query
osid.room.BuildingSearchbuildingSearch the building search
Returnosid.room.BuildingSearchResults the building search results
ErrorsNULL_ARGUMENT buildingQuery or buildingSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED buildingQuery or buildingSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetBuildingQueryFromInspector
Description

Gets a building query from an inspector. The inspector is available from a BuildingSearchResults.

Parametersosid.room.BuildingQueryInspectorbuildingQueryInspector a query inspector
Returnosid.room.BuildingQuery the building query
ErrorsNULL_ARGUMENT buildingQueryInspector is null
UNSUPPORTED buildingQueryInspector is not of this service
Compliancemandatory This method must be implemented.