Interface DeviceSearchSession

All Superinterfaces:

AutoCloseable, Closeable, DeviceQuerySession, OsidSession, OsidSession

public interface DeviceSearchSession
extends DeviceQuerySession

This session provides methods for searching among Devices . The search query is constructed using the DeviceQuery .

getDevicesByQuery() is the basic search method and returns a list of Devices . A more advanced search may be performed with getDevicesBySearch() .It accepts a DeviceSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getDevicesBySearch() returns a DeviceSearchResults that can be used to access the resulting DeviceList or be used to perform a search within the result set through DeviceSearch .

This session defines views that offer differing behaviors for searching.

• federated system view: searches include devices in systems of which this system is an ancestor in the system hierarchy
• isolated system view: searches are restricted to devices in this system

Devices may have a record indicated by their respective record types. The query record is accessed via the DeviceQuery .

Method Summary

Modifier and Type	Method	Description
DeviceQuery	getDeviceQueryFromInspector(DeviceQueryInspector deviceQueryInspector)	Gets a device query from an inspector.
DeviceSearchResults	getDevicesBySearch(DeviceQuery deviceQuery, DeviceSearch deviceSearch)	Gets the search results matching the given search query using the given search.
DeviceSearch	getDeviceSearch()	Gets a device search.
DeviceSearchOrder	getDeviceSearchOrder()	Gets a device search order.

Methods inherited from interface Closeable

close

Methods inherited from interface DeviceQuerySession

canSearchDevices, getDeviceQuery, getDevicesByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView

Modifier and Type	Method	Description
boolean	canSearchDevices()	Tests if this user can perform Device lookups.
DeviceQuery	getDeviceQuery()	Gets a device query.
DeviceList	getDevicesByQuery(DeviceQuery deviceQuery)	Gets a list of Devices matching the given device query,
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	useFederatedSystemView()	Federates the view for methods in this session.
void	useIsolatedSystemView()	Isolates the view for methods in this session.

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

getDeviceSearch

DeviceSearch getDeviceSearch()

Gets a device search.

Returns:

the device search

Compliance:

mandatory - This method must be implemented.

getDeviceSearchOrder

DeviceSearchOrder getDeviceSearchOrder()

Gets a device search order. The DeviceSearchOrder is supplied to a DeviceSearch to specify the ordering of results.

Returns:

the device search order

Compliance:

mandatory - This method must be implemented.

getDevicesBySearch

DeviceSearchResults getDevicesBySearch(DeviceQuery deviceQuery,
 DeviceSearch deviceSearch)
                                throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

deviceQuery - the device query

deviceSearch - the device search

Returns:

the device search results

Throws:

NullArgumentException - deviceQuery or deviceSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - deviceQuery or deviceSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDeviceQueryFromInspector

DeviceQuery getDeviceQueryFromInspector(DeviceQueryInspector deviceQueryInspector)

Gets a device query from an inspector. The inspector is available from a DeviceSearchResults .

Parameters:

deviceQueryInspector - a device query inspector

Returns:

the device query

Throws:

NullArgumentException - deviceQueryInspector is null

UnsupportedException - deviceQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.