Interface BuildingSearchSession

All Superinterfaces:

AutoCloseable, BuildingQuerySession, Closeable, OsidSession, OsidSession

public interface BuildingSearchSession
extends BuildingQuerySession

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.

Method Summary

Modifier and Type	Method	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 BuildingQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchBuildings()	Tests if this user can perform Building searches.
BuildingQuery	getBuildingQuery()	Gets a building query.
BuildingList	getBuildingsByQuery(BuildingQuery buildingQuery)	Gets a list of Buildings matching the given building query.
Campus	getCampus()	Gets the Campus associated with this session.
Id	getCampusId()	Gets the Campus Id associated with this session.
void	useFederatedCampusView()	Federates the view for methods in this session.
void	useIsolatedCampusView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.