OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.ResourceRouteAssignmentSession
Implementsosid.OsidSession
Description

This session defines methods to manage resources on routes.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignResourceRoutes
Description

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.

Returnboolean false if routing methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignResourceToRoute
Description

Assigns a resource to a route.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdrouteIda route Id
ErrorsALREADY_EXISTS resourceId already on routeId
NOT_FOUND resourceId or routeId is not found
NULL_ARGUMENT resourceId or routeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRouteSegmentForResource
Description

Updates the route segment for a resource.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdrouteSegmentIda route segment Id
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId or routeSegmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDcoordinate not supported
CompliancemandatoryThis method must be implemented.
MethodremoveResourceFromRoute
Description

Unassigns a resource from a route.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdrouteIda route Id
ErrorsNOT_FOUND resourceId or routeId is not found
NULL_ARGUMENT resourceId or routeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.