public interface AssetSpatialSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSpatialCoverage()
Tests if this user can perform spatial lookups.
|
IdList |
getAssetIdsByLocation(Id locationId)
Gets a list of asset
Ids included within the location. |
IdList |
getAssetIdsBySpatialCoverage(SpatialUnit spatialUnit)
Gets a list of asset
Ids included within the given
spatial coverage. |
IdList |
getAssetLocationIds(Id assetId)
Gets the locations related to the subject of this asset.
|
LocationList |
getAssetLocations(Id assetId)
Gets the locations related to the subject of this asset.
|
AssetList |
getAssetsByLocation(Id locationId)
Gets a list of assets included within the given spatial coverage.
|
AssetList |
getAssetsBySpatialCoverage(SpatialUnit spatialUnit)
Gets a list of assets included within the given spatial coverage.
|
SpatialUnitList |
getAssetSpatialCoverage(Id assetId)
Gets the spacial coverage related to the subject of this asset.
|
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
void |
useComparativeAssetView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedRepositoryView()
Federates the view for methods in this session.
|
void |
useIsolatedRepositoryView()
Isolates the view for methods in this session.
|
void |
usePlenaryAssetView()
A complete view of the
Asset returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getRepositoryId()
Repository
Id
associated with
this session. Repository Id
associated with this sessionmandatory
- This method must be implemented. Repository getRepository() throws OperationFailedException, PermissionDeniedException
Repository
associated with this session. Repository
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupSpatialCoverage()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations. false
if spatial lookups are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeAssetView()
mandatory
- This method is must be implemented. void usePlenaryAssetView()
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.mandatory
- This method is must be implemented. void useFederatedRepositoryView()
mandatory
- This method is must be implemented. void useIsolatedRepositoryView()
mandatory
- This method is must be implemented. IdList getAssetLocationIds(Id assetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
to queryNotFoundException
- assetId
is not foundNullArgumentException
- assetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LocationList getAssetLocations(Id assetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
to queryNotFoundException
- assetId
is not foundNullArgumentException
- assetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpatialUnitList getAssetSpatialCoverage(Id assetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
to queryNotFoundException
- assetId
is not foundNullArgumentException
- assetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAssetIdsByLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
Ids
included within the location.locationId
- a location Id
Ids
NullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssetList getAssetsByLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
locationId
- a location Id
NullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAssetIdsBySpatialCoverage(SpatialUnit spatialUnit) throws OperationFailedException, PermissionDeniedException
Ids
included within the given
spatial coverage.spatialUnit
- a spatial unit Ids
NullArgumentException
- spatialUnit
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssetList getAssetsBySpatialCoverage(SpatialUnit spatialUnit) throws OperationFailedException, PermissionDeniedException
spatialUnit
- a spatial unitNullArgumentException
- spatialUnit
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.