org.osid.mapping.route

Interface ResourceRouteAssignmentSession

All Superinterfaces:

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

public interface ResourceRouteAssignmentSession
extends OsidSession

This session defines methods to manage resources on routes.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignResourceToRoute(Id resourceId, Id routeId) Assigns a resource to a route.
boolean	canAssignResourceRoutes() Tests if this user can set the routes for resources.
Map	getMap() Gets the Map associated with this session.
Id	getMapId() Gets the Map Id associated with this session.
void	removeResourceFromRoute(Id resourceId, Id routeId) Unassigns a resource from a route.
void	updateRouteSegmentForResource(Id resourceId, Id routeSegmentId) Updates the route segment for a resource.

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.

canAssignResourceRoutes

boolean canAssignResourceRoutes()

Tests if this user can set the routes for resources. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer assignment operations to unauthorized users.

Returns:

false if routing methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignResourceToRoute

void assignResourceToRoute(Id resourceId,
                         Id routeId)
                           throws AlreadyExistsException,
                                  NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Assigns a resource to a route.

Parameters:

resourceId - a resource Id

routeId - a route Id

Throws:

AlreadyExistsException - resourceId already on routeId

NotFoundException - resourceId or routeId is not found

NullArgumentException - resourceId or routeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRouteSegmentForResource

void updateRouteSegmentForResource(Id resourceId,
                                 Id routeSegmentId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Updates the route segment for a resource.

Parameters:

resourceId - a resource Id

routeSegmentId - a route segment Id

Throws:

NotFoundException - resourceId is not found

NullArgumentException - resourceId or routeSegmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - coordinate not supported

Compliance:

mandatory - This method must be implemented.

removeResourceFromRoute

void removeResourceFromRoute(Id resourceId,
                           Id routeId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Unassigns a resource from a route.

Parameters:

resourceId - a resource Id

routeId - a route Id

Throws:

NotFoundException - resourceId or routeId is not found

NullArgumentException - resourceId or routeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.