org.osid.mapping.path.rules

Interface ObstacleEnablerMapAssignmentSession

All Superinterfaces:

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

public interface ObstacleEnablerMapAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignObstacleEnablerToMap(Id obstacleEnablerId, Id mapId) Adds an existing ObstacleEnabler to an Map.
boolean	canAssignObstacleEnablers() Tests if this user can alter obstacle enabler/map mappings.
boolean	canAssignObstacleEnablersToMap(Id mapId) Tests if this user can alter obstacle enabler/map mappings.
IdList	getAssignableMapIds(Id mapId) Gets a list of maps including and under the given map node in which any obstacle enabler can be assigned.
IdList	getAssignableMapIdsForObstacleEnabler(Id mapId, Id obstacleEnablerId) Gets a list of maps including and under the given map node in which a specific obstacle enabler can be assigned.
void	unassignObstacleEnablerFromMap(Id obstacleEnablerId, Id mapId) Removes an ObstacleEnabler 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

canAssignObstacleEnablers

boolean canAssignObstacleEnablers()

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

canAssignObstacleEnablersToMap

boolean canAssignObstacleEnablersToMap(Id mapId)

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

getAssignableMapIdsForObstacleEnabler

IdList getAssignableMapIdsForObstacleEnabler(Id mapId,
                                           Id obstacleEnablerId)
                                             throws OperationFailedException

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

Parameters:

mapId - the Id of the Map

obstacleEnablerId - the Id of the ObstacleEnabler

Returns:

list of assignable map Ids

Throws:

NullArgumentException - mapId or obstacleEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignObstacleEnablerToMap

void assignObstacleEnablerToMap(Id obstacleEnablerId,
                              Id mapId)
                                throws AlreadyExistsException,
                                       NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Adds an existing ObstacleEnabler to an Map.

Parameters:

obstacleEnablerId - the Id of the ObstacleEnabler

mapId - the Id of the Map

Throws:

AlreadyExistsException - obstacleEnablerId is already assigned to mapId

NotFoundException - obstacleEnablerId or mapId not found

NullArgumentException - obstacleEnablerId or mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignObstacleEnablerFromMap

void unassignObstacleEnablerFromMap(Id obstacleEnablerId,
                                  Id mapId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Removes an ObstacleEnabler from an Map.

Parameters:

obstacleEnablerId - the Id of the ObstacleEnabler

mapId - the Id of the Map

Throws:

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

NullArgumentException - obstacleEnablerId or mapId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.