OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
repository package
Version 3.0.0
Release Candidate Preview
| Interface | osid.repository.AssetSpatialSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session defines methods to access spatial mappings of
an asset. The views correspond to those defined in the | ||
| Method | getRepositoryId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Repository Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRepository | ||
| Description |
Gets the | ||
| Return | osid.repository.Repository | the Repository associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canLookupSpatialCoverage | ||
| Description |
Tests if this user can perform spatial lookups. 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 spatial lookups are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useComparativeAssetView | ||
| 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 | usePlenaryAssetView | ||
| Description |
A complete view of the | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useFederatedRepositoryView | ||
| Description |
Federates the view for methods in this session. A federated view will include assets in repositories which are children of this repository in the repository hierarchy. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useIsolatedRepositoryView | ||
| Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this repository only. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getAssetLocationIds | ||
| Description |
Gets the locations related to the subject of this asset. | ||
| Parameters | osid.id.Id | assetId | Id of the Asset to query |
| Return | osid.id.IdList | a list of locations relevant to the subject of this asset | |
| Errors | NOT_FOUND | assetId is not found | |
| NULL_ARGUMENT | assetId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetLocations | ||
| Description |
Gets the locations related to the subject of this asset. | ||
| Parameters | osid.id.Id | assetId | Id of the Asset to query |
| Return | osid.mapping.LocationList | a list of locations relevant to the subject of this asset | |
| Errors | NOT_FOUND | assetId is not found | |
| NULL_ARGUMENT | assetId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetSpatialCoverage | ||
| Description |
Gets the spacial coverage related to the subject of this asset. Each element of the returned list indicates a point in space with specified granularity and uncertainty, or a spatial area. If the list contains more than one element, each element indicates a relevant time or period for the subject of this asset. | ||
| Parameters | osid.id.Id | assetId | Id of the Asset to query |
| Return | osid.mapping.SpatialUnitList | a list of locations relevant to the subject of this asset | |
| Errors | NOT_FOUND | assetId is not found | |
| NULL_ARGUMENT | assetId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetIdsByLocation | ||
| Description |
Gets a list of asset | ||
| Parameters | osid.id.Id | locationId | a location Id |
| Return | osid.id.IdList | a list of asset Ids | |
| Errors | NULL_ARGUMENT | locationId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetsByLocation | ||
| Description |
Gets a list of assets included within the given spatial coverage. | ||
| Parameters | osid.id.Id | locationId | a location Id |
| Return | osid.repository.AssetList | a list of assets | |
| Errors | NULL_ARGUMENT | locationId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetIdsBySpatialCoverage | ||
| Description |
Gets a list of asset | ||
| Parameters | osid.mapping.SpatialUnit | spatialUnit | a spatial unit |
| Return | osid.id.IdList | a list of asset Ids | |
| Errors | NULL_ARGUMENT | spatialUnit is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetsBySpatialCoverage | ||
| Description |
Gets a list of assets included within the given spatial coverage. | ||
| Parameters | osid.mapping.SpatialUnit | spatialUnit | a spatial unit |
| Return | osid.repository.AssetList | a list of assets | |
| Errors | NULL_ARGUMENT | spatialUnit is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |