org.osid.control.rules

Interface DeviceEnablerQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

DeviceEnablerSearchSession

public interface DeviceEnablerQuerySession
extends OsidSession

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

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

Device constrainer enablers 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
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 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

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchDeviceEnablers

boolean canSearchDeviceEnablers()

Tests if this user can perform DeviceEnabler lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedSystemView

void useFederatedSystemView()

Federates the view for methods in this session. A federated view will include device enablers in systems which are children of this broker in the system hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedSystemView

void useIsolatedSystemView()

Isolates the view for methods in this session. An isolated view restricts lookups to this system only.

Compliance:

mandatory - This method is must be implemented.

getDeviceEnablerQuery

DeviceEnablerQuery getDeviceEnablerQuery()

Gets a device enabler query.

Returns:

the device enabler query

Compliance:

mandatory - This method must be implemented.

getDeviceEnablersByQuery

DeviceEnablerList getDeviceEnablersByQuery(DeviceEnablerQuery deviceEnablerQuery)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets a list of DeviceEnablers matching the given search.

Parameters:

deviceEnablerQuery - the device constraienr enabler query

Returns:

the returned DeviceEnablerList

Throws:

NullArgumentException - deviceEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - deviceEnablerQuery is not of this service

Compliance:

mandatory - This method must be implemented.