Interface SignalEnablerMapSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SignalEnablerMapSession
extends OsidSession

This session provides methods to retrieve SignalEnabler to Map mappings. A SignalEnabler 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	canLookupSignalEnablerMapMappings()	Tests if this user can perform lookups of signal enabler/map mappings.
IdList	getMapIdsBySignalEnabler(Id signalEnablerId)	Gets the Map Ids mapped to a SignalEnabler .
MapList	getMapsBySignalEnabler(Id signalEnablerId)	Gets the Maps mapped to a SignalEnabler .
IdList	getSignalEnablerIdsByMap(Id mapId)	Gets the list of SignalEnablerIds associated with an Map .
IdList	getSignalEnablerIdsByMaps(IdList mapIds)	Gets the list of SignalEnabler Ids corresponding to a list of Maps .
SignalEnablerList	getSignalEnablersByMap(Id mapId)	Gets the list of signal enabler associated with an Map .
SignalEnablerList	getSignalEnablersByMaps(IdList mapIds)	Gets the list of signal enabler corresponding to a list of Maps .
void	useComparativeSignalEnablerMapView()	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	usePlenarySignalEnablerMapView()	A complete view of the SignalEnabler 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

canLookupSignalEnablerMapMappings

boolean canLookupSignalEnablerMapMappings()

Tests if this user can perform lookups of signal enabler/map mappings. 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 mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSignalEnablerMapView

void useComparativeSignalEnablerMapView()

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.

usePlenarySignalEnablerMapView

void usePlenarySignalEnablerMapView()

A complete view of the SignalEnabler 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.

getSignalEnablerIdsByMap

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

Gets the list of SignalEnablerIds associated with an Map .

Parameters:

mapId - Id of the Map

Returns:

list of related signal enabler 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.

getSignalEnablersByMap

SignalEnablerList getSignalEnablersByMap(Id mapId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of signal enabler associated with an Map .

Parameters:

mapId - Id of the Map

Returns:

list of related signal enablers

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.

getSignalEnablerIdsByMaps

IdList getSignalEnablerIdsByMaps(IdList mapIds)
                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

mapIds - list of map Ids

Returns:

list of signal enabler Ids

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSignalEnablersByMaps

SignalEnablerList getSignalEnablersByMaps(IdList mapIds)
                                   throws OperationFailedException,
PermissionDeniedException

Gets the list of signal enabler corresponding to a list of Maps .

Parameters:

mapIds - list of map Ids

Returns:

list of signal enablers

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapIdsBySignalEnabler

IdList getMapIdsBySignalEnabler(Id signalEnablerId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Map Ids mapped to a SignalEnabler .

Parameters:

signalEnablerId - Id of a SignalEnabler

Returns:

list of maps

Throws:

NotFoundException - signalEnablerId is not found

NullArgumentException - signalEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapsBySignalEnabler

MapList getMapsBySignalEnabler(Id signalEnablerId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Maps mapped to a SignalEnabler .

Parameters:

signalEnablerId - Id of a SignalEnabler

Returns:

list of maps

Throws:

NotFoundException - signalEnablerId is not found

NullArgumentException - signalEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.