| Interface | osid.repository.AssetSpatialAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session defines methods to manage the spatial coverage of an asset.  | ||
| 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 | canAssignSpatialCoverage | ||
| Description | 
                     Tests if this user can manage 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 management is not authorized,  true 
 otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | addAssetLocation | ||
| Description | 
                     Adds a location to an asset.  | ||
| Parameters | osid.id.Id | assetId |  Id  of the  Asset   | 
osid.id.Id | locationId | a location  Id   | |
| Errors | ALREADY_EXISTS | asset already contains this spatial coverage | |
| NOT_FOUND |  assetId  or  locationId  not  found 
  |                 ||
| NULL_ARGUMENT |  assetId  or  locationId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization fauilure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addAssetSpatialCoverage | ||
| Description | 
                     Adds a spatial coverage to an asset.  | ||
| Parameters | osid.id.Id | assetId |  Id  of the  Asset   | 
osid.mapping.SpatialUnit | spatialUnit | spatial coverage | |
| Errors | ALREADY_EXISTS | asset already contains this spatial coverage | |
| NOT_FOUND |  assetId  not  found   |                 ||
| NULL_ARGUMENT |  assetId  or  spatialUnit  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization fauilure | ||
| UNSUPPORTED |  spatialUnit  not supported  |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeAssetLocation | ||
| Description | 
                     Removes a location from an asset.  | ||
| Parameters | osid.id.Id | assetId |  Id  of the  Asset   | 
osid.id.Id | locationId | spatial coverage | |
| Errors | NOT_FOUND |  assetId  with  locationId  not  found 
  |                 |
| NULL_ARGUMENT |  assetId  or  locationId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization fauilure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeAssetSpatialCoverage | ||
| Description | 
                     Removes a spatial coverage from an asset.  | ||
| Parameters | osid.id.Id | assetId |  Id  of the  Asset   | 
osid.mapping.SpatialUnit | spatialUnit | spatial coverage | |
| Errors | NOT_FOUND |  assetId  with  spatialUnit  not  found 
  |                 |
| NULL_ARGUMENT |  assetId  or  spatialUnit  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization fauilure | ||
| Compliance | mandatory | This method must be implemented. | |