OSID Logo
OSID Specifications
mapping path package
Version 3.1.0
Interfaceosid.mapping.path.ResourceVelocityUpdateSession
Implementsosid.OsidSession
Used Byosid.mapping.path.MappingPathManager
osid.mapping.path.MappingPathProxyManager
Description

This session defines methods to update resource velocities.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Id the Map Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Map the map
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanUpdateResourceVelocities
Description

Tests if this user can set the velocities of 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 location operations to unauthorized users.

Returnboolean false if update methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodupdateResourceVelocity
Description

Updates the velocity of the resource.

Parametersosid.id.IdresourceId a resource Id
osid.mapping.Speedspeed a speed
osid.mapping.Headingheading a heading expressed as a target coordinate
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId, speed or heading is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateResourceCoordinate
Description

Updates the coordinate of the resource.

Parametersosid.id.IdresourceId a resource Id
osid.mapping.Coordinatecoordinate a coordinate
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId or coordinate is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED coordinate not supported
Compliancemandatory This method must be implemented.