org.osid.control.rules

Interface DeviceEnablerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DeviceEnablerQuerySession, 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

Methods

Modifier and Type	Method and 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 org.osid.control.rules.DeviceEnablerQuerySession

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

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

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.