org.osid.mapping.path.rules

Interface SpeedZoneEnablerRuleApplicationSession

All Superinterfaces:

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

public interface SpeedZoneEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply SpeedZoneEnablers to SpeedZones. a SpeedZone with multiple SpeedZoneEnablers means any positive rule evaluation across the enablers result in an effective SpeedZone.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignSpeedZoneEnablerToSpeedZone(Id speedZoneEnablerId, Id speedZoneId) Adds an existing SpeedZoneEnabler to a SpeedZone.
boolean	canAssignSpeedZoneEnablers() Tests if this user can alter speed zone enabler/speed zone mappings.
boolean	canSequenceSpeedZoneEnablers() Tests if this user can order SpeedZoneEnablers.
Map	getMap() Gets the Map associated with this session.
Id	getMapId() Gets the Map Id associated with this session.
void	moveSpeedZoneEnablerAhead(Id speedZoneEnablerId, Id speedZoneId, Id referenceId) Reorders speed zone enablers for a speed zone by moving the specified speed zone enabler in front of a reference speed zone enabler.
void	moveSpeedZoneEnablerBehind(Id speedZoneEnablerId, Id speedZoneId, Id referenceId) Reorders speed zone enablers for a speed zone by moving the specified speed zone enabler behind a reference speed zone enabler.
void	orderSpeedZoneEnablers(Id[] speedZoneEnablerIds, Id speedZoneId) Reorders a set of speed zone enablers for a speed zone.
void	unassignSpeedZoneEnablerFromSpeedZone(Id speedZoneEnablerId, Id speedZoneId) Removes a SpeedZoneEnabler from a SpeedZone.

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

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
           throws OperationFailedException,
                  PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignSpeedZoneEnablers

boolean canAssignSpeedZoneEnablers()

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

assignSpeedZoneEnablerToSpeedZone

void assignSpeedZoneEnablerToSpeedZone(Id speedZoneEnablerId,
                                     Id speedZoneId)
                                       throws AlreadyExistsException,
                                              NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Adds an existing SpeedZoneEnabler to a SpeedZone.

Parameters:

speedZoneEnablerId - the Id of the SpeedZoneEnabler

speedZoneId - the Id of the SpeedZone

Throws:

AlreadyExistsException - speedZoneEnablerId is already applied to speedZoneId

NotFoundException - speedZoneEnablerId or speedZoneId not found

NullArgumentException - speedZoneEnablerId or speed zoneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSpeedZoneEnablerFromSpeedZone

void unassignSpeedZoneEnablerFromSpeedZone(Id speedZoneEnablerId,
                                         Id speedZoneId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Removes a SpeedZoneEnabler from a SpeedZone.

Parameters:

speedZoneEnablerId - the Id of the SpeedZoneEnabler

speedZoneId - the Id of the SpeedZone

Throws:

NotFoundException - speedZoneEnablerId or speedZoneId not found or speedZoneEnablerId not applied to speedZoneId

NullArgumentException - speedZoneEnablerId or speed zoneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceSpeedZoneEnablers

boolean canSequenceSpeedZoneEnablers()

Tests if this user can order SpeedZoneEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if SpeedZoneEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveSpeedZoneEnablerAhead

void moveSpeedZoneEnablerAhead(Id speedZoneEnablerId,
                             Id speedZoneId,
                             Id referenceId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Reorders speed zone enablers for a speed zone by moving the specified speed zone enabler in front of a reference speed zone enabler.

Parameters:

speedZoneEnablerId - the Id of a SpeedZoneEnabler

speedZoneId - the Id of a SpeedZone

referenceId - the reference speed zone enabler Id

Throws:

NotFoundException - speedZoneEnablerId, speed zoneId, or referenceId not found or, speedZoneEnablerId or referenceId not related to speedZoneId

NullArgumentException - speedZoneEnablerId, speed zoneId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveSpeedZoneEnablerBehind

void moveSpeedZoneEnablerBehind(Id speedZoneEnablerId,
                              Id speedZoneId,
                              Id referenceId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Reorders speed zone enablers for a speed zone by moving the specified speed zone enabler behind a reference speed zone enabler.

Parameters:

speedZoneEnablerId - the Id of a SpeedZoneEnabler

speedZoneId - the Id of a SpeedZone

referenceId - the reference speed zone enabler Id

Throws:

NotFoundException - speedZoneEnablerId, speed zoneId, or referenceId not found or, speedZoneEnablerId or referenceId not related to speedZoneId

NullArgumentException - speedZoneEnablerId, speed zoneId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderSpeedZoneEnablers

void orderSpeedZoneEnablers(Id[] speedZoneEnablerIds,
                          Id speedZoneId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Reorders a set of speed zone enablers for a speed zone.

Parameters:

speedZoneEnablerIds - the Ids for a set of SpeedZoneEnablers

speedZoneId - the Id of a SpeedZone

Throws:

NotFoundException - speedZoneId not found or, an speedZoneEnablerId not related to speedZoneId

NullArgumentException - speedZoneEnablerIds or speedZoneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.