OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.SignalEnablerMapSession
Implementsosid.OsidSession
Description

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
MethodcanLookupSignalEnablerMapMappings
Description

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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSignalEnablerMapView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySignalEnablerMapView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodgetSignalEnablerIdsByMap
Description

Gets the list of SignalEnablerIds associated with an Map.

Parametersosid.id.IdmapId Id of the Map
Returnosid.id.IdListlist of related signal enabler Ids
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablersByMap
Description

Gets the list of signal enabler associated with an Map.

Parametersosid.id.IdmapId Id of the Map
Returnosid.mapping.path.rules.SignalEnablerListlist of related signal enablers
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablerIdsByMaps
Description

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

Parametersosid.id.IdListmapIdslist of map Ids
Returnosid.id.IdListlist of signal enabler Ids
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablersByMaps
Description

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

Parametersosid.id.IdListmapIdslist of map Ids
Returnosid.mapping.path.rules.SignalEnablerListlist of signal enablers
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapIdsBySignalEnabler
Description

Gets the Map Ids mapped to a SignalEnabler.

Parametersosid.id.IdsignalEnablerId Id of a SignalEnabler
Returnosid.id.IdListlist of maps
ErrorsNOT_FOUND signalEnablerId is not found
NULL_ARGUMENT signalEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapsBySignalEnabler
Description

Gets the Maps mapped to a SignalEnabler.

Parametersosid.id.IdsignalEnablerId Id of a SignalEnabler
Returnosid.mapping.MapListlist of maps
ErrorsNOT_FOUND signalEnablerId is not found
NULL_ARGUMENT signalEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.