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

This session provides methods to retrieve Location to Map locations. A Location may appear in multiple Map objects. Each map may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupLocationMapLocations
Description

Tests if this user can perform lookups of location/map locations. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up locations is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeLocationMapView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryLocationMapView
Description

A complete view of the Location and Map returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetLocationIdsByMap
Description

Gets the list of Location Ids associated with a Map.

Parametersosid.id.IdmapId Id of the Map
Returnosid.id.IdListlist of related location Ids
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLocationsByMap
Description

Gets the list of Locations associated with a Map.

Parametersosid.id.IdmapId Id of the Map
Returnosid.mapping.LocationListlist of related locations
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLocationIdsByMaps
Description

Gets the list of Location Ids corresponding to a list of Maps.

Parametersosid.id.IdListmapIdslist of map Ids
Returnosid.id.IdListlist of location Ids
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLocationsByMaps
Description

Gets the list of Locations corresponding to a list of Maps.

Parametersosid.id.IdListmapIdslist of map Ids
Returnosid.mapping.LocationListlist of locations
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapIdsByLocation
Description

Gets the Map Ids mapped to a Location.

Parametersosid.id.IdlocationId Id of a Location
Returnosid.id.IdListlist of maps
ErrorsNOT_FOUND locationId is not found
NULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapsByLocation
Description

Gets the Maps mapped to a Location.

Parametersosid.id.IdlocationId Id of a Location
Returnosid.mapping.MapListlist of maps
ErrorsNOT_FOUND locationId is not found
NULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.