Interface SignalMapSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SignalMapSession
extends OsidSession

This session provides methods to retrieve Signal to Map signals. A Signal may appear in multiple Map objects. Each map may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupSignalMapSignals()	Tests if this user can perform lookups of signal/map signals.
IdList	getMapIdsBySignal(Id signalId)	Gets the Map Ids mapped to a Signal .
MapList	getMapsBySignal(Id signalId)	Gets the Maps mapped to a Signal .
IdList	getSignalIdsByMap(Id mapId)	Gets the list of Signal Ids associated with a Map .
IdList	getSignalIdsByMaps(IdList mapIds)	Gets the list of Signal Ids corresponding to a list of Maps .
SignalList	getSignalsByMap(Id mapId)	Gets the list of Signals associated with a Map .
SignalList	getSignalsByMaps(IdList mapIds)	Gets the list of Signals corresponding to a list of Maps .
void	useComparativeSignalMapView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenarySignalMapView()	A complete view of the Signal and Map returns is desired.

Methods inherited from interface Closeable

close

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

canLookupSignalMapSignals

boolean canLookupSignalMapSignals()

Tests if this user can perform lookups of signal/map signals. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up signals is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSignalMapView

void useComparativeSignalMapView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenarySignalMapView

void usePlenarySignalMapView()

A complete view of the Signal and Map returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getSignalIdsByMap

IdList getSignalIdsByMap(Id mapId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Signal Ids associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related signal Ids

Throws:

NotFoundException - mapId is not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSignalsByMap

SignalList getSignalsByMap(Id mapId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Signals associated with a Map .

Parameters:

mapId - Id of the Map

Returns:

list of related signals

Throws:

NotFoundException - mapId is not found

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSignalIdsByMaps

IdList getSignalIdsByMaps(IdList mapIds)
                   throws OperationFailedException,
PermissionDeniedException

Gets the list of Signal Ids corresponding to a list of Maps .

Parameters:

mapIds - list of map Ids

Returns:

list of signal Ids

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSignalsByMaps

SignalList getSignalsByMaps(IdList mapIds)
                     throws OperationFailedException,
PermissionDeniedException

Gets the list of Signals corresponding to a list of Maps .

Parameters:

mapIds - list of map Ids

Returns:

list of signals

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapIdsBySignal

IdList getMapIdsBySignal(Id signalId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Map Ids mapped to a Signal .

Parameters:

signalId - Id of a Signal

Returns:

list of maps

Throws:

NotFoundException - signalId is not found

NullArgumentException - signalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsBySignal

MapList getMapsBySignal(Id signalId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Maps mapped to a Signal .

Parameters:

signalId - Id of a Signal

Returns:

list of maps

Throws:

NotFoundException - signalId is not found

NullArgumentException - signalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.