OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.AssetSpatialAssignmentSession
Implementsosid.OsidSession
Description

This session defines methods to manage the spatial coverage of an asset.

MethodgetRepositoryId
Description

Gets the Repository Id associated with this session.

Returnosid.id.Idthe Repository Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRepository
Description

Gets the Repository associated with this session.

Returnosid.repository.Repositorythe Repository associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignSpatialCoverage
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations.

Returnboolean false if spatial management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddAssetLocation
Description

Adds a location to an asset.

Parametersosid.id.IdassetId Id of the Asset
osid.id.IdlocationIda location Id
ErrorsALREADY_EXISTSasset already contains this spatial coverage
NOT_FOUND assetId or locationId not found
NULL_ARGUMENT assetId or locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization fauilure
CompliancemandatoryThis method must be implemented.
MethodaddAssetSpatialCoverage
Description

Adds a spatial coverage to an asset.

Parametersosid.id.IdassetId Id of the Asset
osid.mapping.SpatialUnitspatialUnitspatial coverage
ErrorsALREADY_EXISTSasset already contains this spatial coverage
NOT_FOUND assetId not found
NULL_ARGUMENT assetId or spatialUnit is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization fauilure
UNSUPPORTED spatialUnit not supported
CompliancemandatoryThis method must be implemented.
MethodremoveAssetLocation
Description

Removes a location from an asset.

Parametersosid.id.IdassetId Id of the Asset
osid.id.IdlocationIdspatial coverage
ErrorsNOT_FOUND assetId with locationId not found
NULL_ARGUMENT assetId or locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization fauilure
CompliancemandatoryThis method must be implemented.
MethodremoveAssetSpatialCoverage
Description

Removes a spatial coverage from an asset.

Parametersosid.id.IdassetId Id of the Asset
osid.mapping.SpatialUnitspatialUnitspatial coverage
ErrorsNOT_FOUND assetId with spatialUnit not found
NULL_ARGUMENT assetId or spatialUnit is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization fauilure
CompliancemandatoryThis method must be implemented.