org.osid.room

Interface BuildingSearchSession

All Superinterfaces:

java.lang.AutoCloseable, BuildingQuerySession, java.io.Closeable, OsidSession

public interface BuildingSearchSession
extends BuildingQuerySession

This session provides methods for searching Building objects. 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.

Method Summary

Methods

Modifier and Type	Method and Description
BuildingQuery	getBuildingQueryFromInspector(BuildingQueryInspector buildingQueryInspector) Gets a building query from an inspector.
BuildingSearchResults	getBuildingsBySearch(BuildingQuery buildingQuery, BuildingSearch buildingSearch) Gets the search results matching the given search.
BuildingSearch	getBuildingSearch() Gets a building search.
BuildingSearchOrder	getBuildingSearchOrder() Gets a building search order.

Methods inherited from interface org.osid.room.BuildingQuerySession

canSearchBuildings, getBuildingQuery, getBuildingsByQuery, getCampus, getCampusId, useFederatedCampusView, useIsolatedCampusView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBuildingSearch

BuildingSearch getBuildingSearch()

Gets a building search.

Returns:

the building search

Compliance:

mandatory - This method must be implemented.

getBuildingSearchOrder

BuildingSearchOrder getBuildingSearchOrder()

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

Returns:

the building search order

Compliance:

mandatory - This method must be implemented.

getBuildingsBySearch

BuildingSearchResults getBuildingsBySearch(BuildingQuery buildingQuery,
                                         BuildingSearch buildingSearch)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets the search results matching the given search.

Parameters:

buildingQuery - the building query

buildingSearch - the building search

Returns:

the building search results

Throws:

NullArgumentException - buildingQuery or buildingSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - buildingQuery or buildingSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBuildingQueryFromInspector

BuildingQuery getBuildingQueryFromInspector(BuildingQueryInspector buildingQueryInspector)

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

Parameters:

buildingQueryInspector - a query inspector

Returns:

the building query

Throws:

NullArgumentException - buildingQueryInspector is null

UnsupportedException - buildingQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.