org.osid.mapping.path

Interface SignalSmartMapSession

All Superinterfaces:

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

public interface SignalSmartMapSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A SignalQuery can be retrieved from this session and mapped to this Map to create a virtual collection of Signals. The signals may be sequenced using the SignalSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applySignalQuery(SignalQuery signalQuery) Applies a signal query to this map.
void	applySignalSequencing(SignalSearchOrder signalSearchOrder) Applies a signal 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.
SignalQuery	getSignalQuery() Gets a signal query.
SignalQuery	getSignalQueryFromInspector(SignalQueryInspector signalQueryInspector) Gets a signal query from an inspector.
SignalSearchOrder	getSignalSearchOrder() Gets a signal search order.
SignalQueryInspector	inspecSignalQuery() Gets a signal 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.

getSignalQuery

SignalQuery getSignalQuery()

Gets a signal query.

Returns:

the signal query

Compliance:

mandatory - This method must be implemented.

getSignalSearchOrder

SignalSearchOrder getSignalSearchOrder()

Gets a signal search order.

Returns:

the signal search order

Compliance:

mandatory - the signal search order

applySignalQuery

void applySignalQuery(SignalQuery signalQuery)
                      throws OperationFailedException,
                             PermissionDeniedException

Applies a signal query to this map.

Parameters:

signalQuery - the signal query

Throws:

NullArgumentException - signalQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - signalQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspecSignalQuery

SignalQueryInspector inspecSignalQuery()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a signal query inspector for this map.

Returns:

the signal query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySignalSequencing

void applySignalSequencing(SignalSearchOrder signalSearchOrder)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies a signal search order to this map.

Parameters:

signalSearchOrder - the signal search order

Throws:

NullArgumentException - signalSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - signalSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSignalQueryFromInspector

SignalQuery getSignalQueryFromInspector(SignalQueryInspector signalQueryInspector)

Gets a signal query from an inspector.

Parameters:

signalQueryInspector - a signal query inspector

Returns:

the signal query

Throws:

NullArgumentException - signalQueryInspector is null

UnsupportedException - signalQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.