org.osid.mapping.path.rules

Interface SpeedZoneEnablerMapAssignmentSession

All Superinterfaces:

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

public interface SpeedZoneEnablerMapAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignSpeedZoneEnablerToMap(Id speedZoneEnablerId, Id mapId) Adds an existing SpeedZoneEnabler to an Map.
boolean	canAssignSpeedZoneEnablers() Tests if this user can alter speed zone enabler/map mappings.
boolean	canAssignSpeedZoneEnablersToMap(Id mapId) Tests if this user can alter speed zone enabler/map mappings.
IdList	getAssignableMapIds(Id mapId) Gets a list of map including and under the given map node in which any speed zone enabler can be assigned.
IdList	getAssignableMapIdsForSpeedZoneEnabler(Id mapId, Id speedZoneEnablerId) Gets a list of map including and under the given map node in which a specific speed zone enabler can be assigned.
void	unassignSpeedZoneEnablerFromMap(Id speedZoneEnablerId, Id mapId) Removes a SpeedZoneEnabler 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

canAssignSpeedZoneEnablers

boolean canAssignSpeedZoneEnablers()

Tests if this user can alter speed zone 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.

canAssignSpeedZoneEnablersToMap

boolean canAssignSpeedZoneEnablersToMap(Id mapId)

Tests if this user can alter speed zone 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 map including and under the given map node in which any speed zone 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.

getAssignableMapIdsForSpeedZoneEnabler

IdList getAssignableMapIdsForSpeedZoneEnabler(Id mapId,
                                            Id speedZoneEnablerId)
                                              throws OperationFailedException

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

Parameters:

mapId - the Id of the Map

speedZoneEnablerId - the Id of the SpeedZoneEnabler

Returns:

list of assignable map Ids

Throws:

NullArgumentException - mapId or speedZoneEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignSpeedZoneEnablerToMap

void assignSpeedZoneEnablerToMap(Id speedZoneEnablerId,
                               Id mapId)
                                 throws AlreadyExistsException,
                                        NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Adds an existing SpeedZoneEnabler to an Map.

Parameters:

speedZoneEnablerId - the Id of the SpeedZoneEnabler

mapId - the Id of the Map

Throws:

AlreadyExistsException - speedZoneEnablerId is already assigned to mapId

NotFoundException - speedZoneEnablerId or mapId not found

NullArgumentException - speedZoneEnablerId or mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSpeedZoneEnablerFromMap

void unassignSpeedZoneEnablerFromMap(Id speedZoneEnablerId,
                                   Id mapId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Removes a SpeedZoneEnabler from an Map.

Parameters:

speedZoneEnablerId - the Id of the SpeedZoneEnabler

mapId - the Id of the Map

Throws:

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

NullArgumentException - speedZoneEnablerId or mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.