OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
mapping package
Version 3.0.0
Release Candidate Preview
| Interface | osid.mapping.ResourceLocationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session defines methods to look up resources on a map. | ||
| Method | getMapId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Map Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMap | ||
| Description |
Gets the | ||
| Return | osid.mapping.Map | the map | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAccessResourceLocations | ||
| Description |
Tests if this user can access 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 | ||
| Return | boolean | false if location methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useComparativeResourceLocationView | ||
| 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 | usePlenaryResourceLocationView | ||
| Description |
A complete view of the | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useFederatedMapView | ||
| Description |
Federates the view for methods in this session. A federated view will include paths in maps which are children of this map in the map hierarchy. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useIsolatedMapView | ||
| Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this map only. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getResourceLocation | ||
| Description |
Gets the current closest bounding location of the given resource. The returned ResourceLocation may not indicate a known location if no location is known. | ||
| Parameters | osid.id.Id | resourceId | a resource Id |
| Return | osid.mapping.ResourceLocation | the current location | |
| Errors | NOT_FOUND | resourceId is not on map | |
| NULL_ARGUMENT | resourceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceLocations | ||
| Description |
Gets the current closest bounding locations of the given resources. In plenary mode, the returned list contains all of the locations of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered. | ||
| Parameters | osid.id.IdList | resourceIds | a resource list |
| Return | osid.mapping.ResourceLocationList | the current locations | |
| Errors | NOT_FOUND | a resource Id is not on map | |
| NULL_ARGUMENT | resourceIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourcesAtLocation | ||
| Description |
Gets the current resources at or within the given location. | ||
| Parameters | osid.id.Id | locationId | a location Id |
| Return | osid.mapping.ResourceLocationList | the resources at the location | |
| Errors | NOT_FOUND | locationId 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 | getResourcesAtLocationByGenusType | ||
| Description |
Gets the current resources at or within the given location for a resource genus type. | ||
| Parameters | osid.id.Id | locationId | a location Id |
osid.type.Type | resourceGenusType | a resource genus type | |
| Return | osid.mapping.ResourceLocationList | the resources at the location | |
| Errors | NOT_FOUND | locationId not found | |
| NULL_ARGUMENT | locationId or resourceGenusType is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourcesAtSpatialUnit | ||
| Description |
Gets the current resource within the given spatial unit. | ||
| Parameters | osid.mapping.SpatialUnit | spatialUnit | a spatial unit |
| Return | osid.mapping.ResourceLocationList | the resources at the location | |
| Errors | NULL_ARGUMENT | spatialUnit is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourcesAtSpatialUnitByGenusType | ||
| Description |
Gets the current resource within the given spatial unit for a given resource genus type. | ||
| Parameters | osid.mapping.SpatialUnit | spatialUnit | a spatial unit |
osid.type.Type | resourceGenusType | a resource genus type | |
| Return | osid.mapping.ResourceLocationList | the resources at the location | |
| Errors | NULL_ARGUMENT | spatialUnit or resourceGenusType is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |