org.osid.mapping.path.rules

Interface SignalEnablerMapAssignmentSession

All Superinterfaces:

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

public interface SignalEnablerMapAssignmentSession
extends OsidSession

This session provides methods to re-assign SignalEnabler to Map mappings. A SignalEnabler may appear in multiple Map objects and removing the last reference to a SignalEnabler 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 SignalEnabler to another Map is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignSignalEnablerToMap(Id signalEnablerId, Id mapId) Adds an existing SignalEnabler to an Map.
boolean	canAssignSignalEnablers() Tests if this user can alter signal enabler/map mappings.
boolean	canAssignSignalEnablersToMap(Id mapId) Tests if this user can alter signal enabler/map mappings.
IdList	getAssignableMapIds(Id mapId) Gets a list of maps including and under the given map node in which any signal enabler can be assigned.
IdList	getAssignableMapIdsForSignalEnabler(Id mapId, Id signalEnablerId) Gets a list of maps including and under the given map node in which a specific signal enabler can be assigned.
void	unassignSignalEnablerFromMap(Id signalEnablerId, Id mapId) Removes a SignalEnabler from an 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

canAssignSignalEnablers

boolean canAssignSignalEnablers()

Tests if this user can alter signal enabler/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignSignalEnablersToMap

boolean canAssignSignalEnablersToMap(Id mapId)

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

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

getAssignableMapIdsForSignalEnabler

IdList getAssignableMapIdsForSignalEnabler(Id mapId,
                                         Id signalEnablerId)
                                           throws OperationFailedException

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

Parameters:

mapId - the Id of the Map

signalEnablerId - the Id of the SignalEnabler

Returns:

list of assignable map Ids

Throws:

NullArgumentException - mapId or signalEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignSignalEnablerToMap

void assignSignalEnablerToMap(Id signalEnablerId,
                            Id mapId)
                              throws AlreadyExistsException,
                                     NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Adds an existing SignalEnabler to an Map.

Parameters:

signalEnablerId - the Id of the SignalEnabler

mapId - the Id of the Map

Throws:

AlreadyExistsException - signalEnablerId is already assigned to mapId

NotFoundException - signalEnablerId or mapId not found

NullArgumentException - signalEnablerId or mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSignalEnablerFromMap

void unassignSignalEnablerFromMap(Id signalEnablerId,
                                Id mapId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Removes a SignalEnabler from an Map.

Parameters:

signalEnablerId - the Id of the SignalEnabler

mapId - the Id of the Map

Throws:

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

NullArgumentException - signalEnablerId or mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.