public interface AssetSpatialAssignmentSession extends OsidSession
This session defines methods to manage the spatial coverage of an asset.
Modifier and Type | Method and Description |
---|---|
void |
addAssetLocation(Id assetId,
Id locationId)
Adds a location to an asset.
|
void |
addAssetSpatialCoverage(Id assetId,
SpatialUnit spatialUnit)
Adds a spatial coverage to an asset.
|
boolean |
canAssignSpatialCoverage()
Tests if this user can manage spatial lookups.
|
Repository |
getRepository()
Gets the
Repository associated with this session. |
Id |
getRepositoryId()
Gets the
Repository Id associated with
this session. |
void |
removeAssetLocation(Id assetId,
Id locationId)
Removes a location from an asset.
|
void |
removeAssetSpatialCoverage(Id assetId,
SpatialUnit spatialUnit)
Removes a spatial coverage from an asset.
|
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 canAssignSpatialCoverage()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer assignment operations. false
if spatial management is not authorized,
true
otherwisemandatory
- This method must be implemented. void addAssetLocation(Id assetId, Id locationId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
locationId
- a location Id
AlreadyExistsException
- asset already contains this
spatial coverageNotFoundException
- assetId
or
locationId
not found
NullArgumentException
- assetId
or
locationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization fauiluremandatory
- This method must be implemented. void addAssetSpatialCoverage(Id assetId, SpatialUnit spatialUnit) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
spatialUnit
- spatial coverageAlreadyExistsException
- asset already contains this
spatial coverageNotFoundException
- assetId
not
found
NullArgumentException
- assetId
or
spatialUnit
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization fauilureUnsupportedException
- spatialUnit
not
supportedmandatory
- This method must be implemented. void removeAssetLocation(Id assetId, Id locationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
locationId
- spatial coverageNotFoundException
- assetId
with
locationId
not found
NullArgumentException
- assetId
or
locationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization fauiluremandatory
- This method must be implemented. void removeAssetSpatialCoverage(Id assetId, SpatialUnit spatialUnit) throws NotFoundException, OperationFailedException, PermissionDeniedException
assetId
- Id
of the Asset
spatialUnit
- spatial coverageNotFoundException
- assetId
with
spatialUnit
not found
NullArgumentException
- assetId
or
spatialUnit
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization fauiluremandatory
- This method must be implemented.