org.osid.mapping.path.rules

Interface SignalEnablerSmartMapSession

All Superinterfaces:

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

public interface SignalEnablerSmartMapSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic maps. A SignalEnablerQuery can be retrieved from this session and mapped to this Map to create a virtual collection of signal enablers. The signal enabler may be sequenced using the SignalEnablerSearchOrder from this session.

This Map has a default query that matches any signal enabler and a default search order that specifies no sequencing. The queries may be examined using a SignalEnablerQueryInspector. The query may be modified by converting the inspector back to a SignalEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applySignalEnablerQuery(SignalEnablerQuery signalEnablerQuery) Applies a signal enabler query to this map.
void	applySignalEnablerSequencing(SignalEnablerSearchOrder signalEnablerSearchOrder) Applies a signal enabler search order to this map.
boolean	canManageSmartMaps() Tests if this user can manage smart maps.
Map	getMap() Gets the Map associated with this session.
Id	getMapId() Gets the Map Id associated with this session.
SignalEnablerQuery	getSignalEnablerQuery() Gets a signal enabler query.
SignalEnablerQuery	getSignalEnablerQueryFromInspector(SignalEnablerQueryInspector signalEnablerQueryInspector) Gets a signal enabler query from an inspector.
SignalEnablerSearchOrder	getSignalEnablerSearchOrder() Gets a signal enabler search order.
SignalEnablerQueryInspector	inspectSignalEnablerQuery() Gets a signal enabler query inspector for this map.

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

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
           throws OperationFailedException,
                  PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartMaps

boolean canManageSmartMaps()

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

Returns:

false if smart map management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getSignalEnablerQuery

SignalEnablerQuery getSignalEnablerQuery()

Gets a signal enabler query.

Returns:

the signal enabler query

Compliance:

mandatory - This method must be implemented.

getSignalEnablerSearchOrder

SignalEnablerSearchOrder getSignalEnablerSearchOrder()

Gets a signal enabler search order.

Returns:

the signal enabler search order

Compliance:

mandatory - This method must be implemented.

applySignalEnablerQuery

void applySignalEnablerQuery(SignalEnablerQuery signalEnablerQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a signal enabler query to this map.

Parameters:

signalEnablerQuery - the signal enabler query

Throws:

NullArgumentException - signalEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - signalEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectSignalEnablerQuery

SignalEnablerQueryInspector inspectSignalEnablerQuery()
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a signal enabler query inspector for this map.

Returns:

the signal enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySignalEnablerSequencing

void applySignalEnablerSequencing(SignalEnablerSearchOrder signalEnablerSearchOrder)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Applies a signal enabler search order to this map.

Parameters:

signalEnablerSearchOrder - the signal enabler search order

Throws:

NullArgumentException - signalEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - signalEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSignalEnablerQueryFromInspector

SignalEnablerQuery getSignalEnablerQueryFromInspector(SignalEnablerQueryInspector signalEnablerQueryInspector)

Gets a signal enabler query from an inspector.

Parameters:

signalEnablerQueryInspector - a signal enabler query inspector

Returns:

the signal enabler query

Throws:

NullArgumentException - signalEnablerQueryInspector is null

UnsupportedException - signalEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.