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

This session defines methods to access spatial mappings of an asset. The views correspond to those defined in the AssetLookupSession. The locations are defined in the Mapping OSID.

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.
MethodcanLookupSpatialCoverage
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations.

Returnboolean false if spatial lookups are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAssetView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAssetView
Description

A complete view of the Asset returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedRepositoryView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedRepositoryView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this repository only.

CompliancemandatoryThis method is must be implemented.
MethodgetAssetLocationIds
Description

Gets the locations related to the subject of this asset.

Parametersosid.id.IdassetId Id of the Asset to query
Returnosid.id.IdLista list of locations relevant to the subject of this asset
ErrorsNOT_FOUND assetId is not found
NULL_ARGUMENT assetId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetLocations
Description

Gets the locations related to the subject of this asset.

Parametersosid.id.IdassetId Id of the Asset to query
Returnosid.mapping.LocationLista list of locations relevant to the subject of this asset
ErrorsNOT_FOUND assetId is not found
NULL_ARGUMENT assetId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetSpatialCoverage
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.

Parametersosid.id.IdassetId Id of the Asset to query
Returnosid.mapping.SpatialUnitLista list of locations relevant to the subject of this asset
ErrorsNOT_FOUND assetId is not found
NULL_ARGUMENT assetId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetIdsByLocation
Description

Gets a list of asset Ids included within the location.

Parametersosid.id.IdlocationIda location Id
Returnosid.id.IdLista list of asset Ids
ErrorsNULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetsByLocation
Description

Gets a list of assets included within the given spatial coverage.

Parametersosid.id.IdlocationIda location Id
Returnosid.repository.AssetLista list of assets
ErrorsNULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetIdsBySpatialCoverage
Description

Gets a list of asset Ids included within the given spatial coverage.

Parametersosid.mapping.SpatialUnitspatialUnita spatial unit
Returnosid.id.IdLista list of asset Ids
ErrorsNULL_ARGUMENT spatialUnit is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssetsBySpatialCoverage
Description

Gets a list of assets included within the given spatial coverage.

Parametersosid.mapping.SpatialUnitspatialUnita spatial unit
Returnosid.repository.AssetLista list of assets
ErrorsNULL_ARGUMENT spatialUnit is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.