Interface | osid.mapping.LocationMapSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupLocationMapLocations | ||
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
| ||
Return | boolean | false if looking up locations is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeLocationMapView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryLocationMapView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getLocationIdsByMap | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | mapId | Id of the Map |
Return | osid.id.IdList | list of related location Ids | |
Errors | NOT_FOUND | mapId is not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLocationsByMap | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | mapId | Id of the Map |
Return | osid.mapping.LocationList | list of related locations | |
Errors | NOT_FOUND | mapId is not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLocationIdsByMaps | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | mapIds | list of map Ids |
Return | osid.id.IdList | list of location Ids | |
Errors | NULL_ARGUMENT | mapIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLocationsByMaps | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | mapIds | list of map Ids |
Return | osid.mapping.LocationList | list of locations | |
Errors | NULL_ARGUMENT | mapIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMapIdsByLocation | ||
Description |
Gets the | ||
Parameters | osid.id.Id | locationId | Id of a Location |
Return | osid.id.IdList | list of maps | |
Errors | NOT_FOUND | locationId is not found | |
NULL_ARGUMENT | locationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMapsByLocation | ||
Description |
Gets the | ||
Parameters | osid.id.Id | locationId | Id of a Location |
Return | osid.mapping.MapList | list of maps | |
Errors | NOT_FOUND | locationId is not found | |
NULL_ARGUMENT | locationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |