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

This session provides methods to re-assign Signals to Map objects A Signal may appear in multiple Map objects and removing the last reference to a Signal is the equivalent of deleting it. Each Map may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Signal to another Map is not a copy operation (eg: does not change its Id ).

MethodcanAssignSignals
Description

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

Returnboolean false if signal is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignSignalsToMap
Description

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

Parametersosid.id.IdmapIdthe Id of the Map
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT mapId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableMapIds
Description

Gets a list of maps including and under the given map node in which any signal can be assigned.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.id.IdListlist of assignable map Ids
ErrorsNULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableMapIdsForSignal
Description

Gets a list of maps including and under the given map node in which a specific signal can be assigned.

Parametersosid.id.IdmapIdthe Id of the Map
osid.id.IdsignalIdthe Id of the Signal
Returnosid.id.IdListlist of assignable map Ids
ErrorsNULL_ARGUMENT mapId or signalId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignSignalToMap
Description

Adds an existing Signal to a Map.

Parametersosid.id.IdsignalIdthe Id of the Signal
osid.id.IdmapIdthe Id of the Map
ErrorsALREADY_EXISTS signalId is already assigned to mapId
NOT_FOUND signalId or mapId not found
NULL_ARGUMENT signalId or mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignSignalFromMap
Description

Removes a Signal from a Map.

Parametersosid.id.IdsignalIdthe Id of the Signal
osid.id.IdmapIdthe Id of the Map
ErrorsNOT_FOUND signalId or mapId not found or signalId not assigned to mapId
NULL_ARGUMENT signalId or mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.