Interface ResourceRouteAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ResourceRouteAssignmentSession
extends OsidSession

This session defines methods to manage resources on routes.

Method Summary

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.