Interface DeviceEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, DeviceEnablerQuerySession, OsidSession, OsidSession

public interface DeviceEnablerSearchSession
extends DeviceEnablerQuerySession

This session provides methods for searching among DeviceEnabler objects. The search query is constructed using the DeviceEnableryQuery.

getDeviceEnablersByQuery() is the basic search method and returns a list of DeviceEnablers. A more advanced search may be performed with getDeviceEnablersBySearch().It accepts a DeviceEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. getDeviceEnablersBySearch() returns a DeviceEnablerSearchResults that can be used to access the resulting DeviceEnablerList or be used to perform a search within the result set through DeviceEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
DeviceEnablerQuery	getDeviceEnablerQueryFromInspector(DeviceEnablerQueryInspector deviceEnablerQueryInspector)	Gets a device enabler query from an inspector.
DeviceEnablerSearchResults	getDeviceEnablersBySearch(DeviceEnablerQuery deviceEnablerQuery, DeviceEnablerSearch deviceEnablerSearch)	Gets the search results matching the given search query using the given search.
DeviceEnablerSearch	getDeviceEnablerSearch()	Gets a device enabler search.
DeviceEnablerSearchOrder	getDeviceEnablerSearchOrder()	Gets a device enabler search order.

Methods inherited from interface Closeable

close

Methods inherited from interface DeviceEnablerQuerySession

canSearchDeviceEnablers, getDeviceEnablerQuery, getDeviceEnablersByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView

Modifier and Type	Method	Description
boolean	canSearchDeviceEnablers()	Tests if this user can perform DeviceEnabler lookups.
DeviceEnablerQuery	getDeviceEnablerQuery()	Gets a device enabler query.
DeviceEnablerList	getDeviceEnablersByQuery(DeviceEnablerQuery deviceEnablerQuery)	Gets a list of DeviceEnablers matching the given search.
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

getDeviceEnablerSearch

DeviceEnablerSearch getDeviceEnablerSearch()

Gets a device enabler search.

Returns:

the device enabler search

Compliance:

mandatory - This method must be implemented.

getDeviceEnablerSearchOrder

DeviceEnablerSearchOrder getDeviceEnablerSearchOrder()

Gets a device enabler search order. The DeviceEnablerSearchOrder is supplied to a DeviceEnablerSearch to specify the ordering of results.

Returns:

the device enabler search order

Compliance:

mandatory - This method must be implemented.

getDeviceEnablersBySearch

DeviceEnablerSearchResults getDeviceEnablersBySearch(DeviceEnablerQuery deviceEnablerQuery,
 DeviceEnablerSearch deviceEnablerSearch)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

deviceEnablerQuery - the device enabler query

deviceEnablerSearch - the device enabler search

Returns:

the returned search results

Throws:

NullArgumentException - deviceEnablerQuery or deviceEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - deviceEnablerQuery or deviceEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDeviceEnablerQueryFromInspector

DeviceEnablerQuery getDeviceEnablerQueryFromInspector(DeviceEnablerQueryInspector deviceEnablerQueryInspector)

Gets a device enabler query from an inspector. The inspector is available from a DeviceEnablerSearchResults.

Parameters:

deviceEnablerQueryInspector - a device enabler query inspector

Returns:

the device enabler query

Throws:

NullArgumentException - deviceEnablerQueryInspector is null

UnsupportedException - deviceEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.