org.osid.mapping.path

Interface SignalMapAssignmentSession

All Superinterfaces:

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

public interface SignalMapAssignmentSession
extends OsidSession

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 ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignSignalToMap(Id signalId, Id mapId) Adds an existing Signal to a Map.
boolean	canAssignSignals() Tests if this user can alter signal/map mappings.
boolean	canAssignSignalsToMap(Id mapId) Tests if this user can alter signal/map mappings.
IdList	getAssignableMapIds(Id mapId) Gets a list of maps including and under the given map node in which any signal can be assigned.
IdList	getAssignableMapIdsForSignal(Id mapId, Id signalId) Gets a list of maps including and under the given map node in which a specific signal can be assigned.
void	unassignSignalFromMap(Id signalId, Id mapId) Removes a Signal from a 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

canAssignSignals

boolean canAssignSignals()

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.

Returns:

false if signal is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignSignalsToMap

boolean canAssignSignalsToMap(Id mapId)

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.

Parameters:

mapId - the Id of the Map

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - mapId is null

Compliance:

mandatory - This method must be implemented.

getAssignableMapIds

IdList getAssignableMapIds(Id mapId)
                           throws OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

list of assignable map Ids

Throws:

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableMapIdsForSignal

IdList getAssignableMapIdsForSignal(Id mapId,
                                  Id signalId)
                                    throws OperationFailedException

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

Parameters:

mapId - the Id of the Map

signalId - the Id of the Signal

Returns:

list of assignable map Ids

Throws:

NullArgumentException - mapId or signalId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignSignalToMap

void assignSignalToMap(Id signalId,
                     Id mapId)
                       throws AlreadyExistsException,
                              NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Adds an existing Signal to a Map.

Parameters:

signalId - the Id of the Signal

mapId - the Id of the Map

Throws:

AlreadyExistsException - signalId is already assigned to mapId

NotFoundException - signalId or mapId not found

NullArgumentException - signalId or mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSignalFromMap

void unassignSignalFromMap(Id signalId,
                         Id mapId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Removes a Signal from a Map.

Parameters:

signalId - the Id of the Signal

mapId - the Id of the Map

Throws:

NotFoundException - signalId or mapId not found or signalId not assigned to mapId

NullArgumentException - signalId or mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.