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

This session defines update positions of resources.

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.
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
CompliancemandatoryThis method must be implemented.
MethodupdateResourceLocation
Description

Updates the location of the resource.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdlocationIda location Id
ErrorsNOT_FOUND resourceId or locationId is not found
NULL_ARGUMENT resourceId or locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateResourceCoordinate
Description

Updates the coordinate of the resource.

Parametersosid.id.IdresourceIda resource Id
osid.mapping.Coordinatecoordinatea coordinate
ErrorsNOT_FOUND resourceId is not found
NULL_ARGUMENT resourceId or coordinate is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDcoordinate not supported
CompliancemandatoryThis method must be implemented.