OSID Logo
OSID Specifications
mapping package
Version 3.1.0
Interfaceosid.mapping.ResourceLocationUpdateSession
Implementsosid.OsidSession
Used Byosid.mapping.MappingManager
osid.mapping.MappingProxyManager
Description

This session defines update positions of resources.

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.
MethodcanUpdateResourceLocations
Description

Tests if this user can set the locations 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 location methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodupdateResourceLocation
Description

Updates the location of the resource.

Parametersosid.id.IdresourceId a resource Id
osid.id.IdlocationId a location Id
ErrorsNOT_FOUND resourceId or locationId is not found
NULL_ARGUMENT resourceId or locationId 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.