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

This session defines methods to route between locations.

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

Tests if this user can query own location. 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.
MethodatDesignatedLocation
Description

Tests if this agent is at a designated location.

Returnboolean true if the agent is at a designated location, false otherrwise
CompliancemandatoryThis method must be implemented.
MethodgetMyLocation
Description

Gets the current location of this agent.

Returnosid.mapping.Locationthe current location
ErrorsILLEGAL_STATE atDesignatedLocation() is false
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMyCoordinate
Description

Gets the current coordinate of this agent.

Returnosid.mapping.Coordinatethe current coordinate
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetNearestLocationsToMe
Description

Gets the current nearest locations to this agent ordered by distance.

Returnosid.mapping.LocationListthe nearest locations
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetNearestLocationToMeByGenusType
Description

Gets the current nearest location of this agent of the specified location genus type ordered by distance.

Parametersosid.type.TypelocationGenusTypea location genus type
Returnosid.mapping.LocationListthe nearest locations
ErrorsNULL_ARGUMENT locationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.