Interface AssetSpatialAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssetSpatialAssignmentSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getRepositoryId

Id getRepositoryId()

Gets the Repository Id associated with this session.

Returns:

the Repository Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRepository

Repository getRepository()
                  throws OperationFailedException,
PermissionDeniedException

Gets the Repository associated with this session.

Returns:

the Repository associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignSpatialCoverage

boolean canAssignSpatialCoverage()

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.

Returns:

false if spatial management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addAssetLocation

void addAssetLocation(Id assetId,
 Id locationId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a location to an asset.

Parameters:

assetId - Id of the Asset

locationId - a location Id

Throws:

AlreadyExistsException - asset already contains this spatial coverage

NotFoundException - assetId or locationId not found

NullArgumentException - assetId or locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.

addAssetSpatialCoverage

void addAssetSpatialCoverage(Id assetId,
 SpatialUnit spatialUnit)
                      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a spatial coverage to an asset.

Parameters:

assetId - Id of the Asset

spatialUnit - spatial coverage

Throws:

AlreadyExistsException - asset already contains this spatial coverage

NotFoundException - assetId not found

NullArgumentException - assetId or spatialUnit is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

UnsupportedException - spatialUnit not supported

Compliance:

mandatory - This method must be implemented.

removeAssetLocation

void removeAssetLocation(Id assetId,
 Id locationId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a location from an asset.

Parameters:

assetId - Id of the Asset

locationId - spatial coverage

Throws:

NotFoundException - assetId with locationId not found

NullArgumentException - assetId or locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.

removeAssetSpatialCoverage

void removeAssetSpatialCoverage(Id assetId,
 SpatialUnit spatialUnit)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a spatial coverage from an asset.

Parameters:

assetId - Id of the Asset

spatialUnit - spatial coverage

Throws:

NotFoundException - assetId with spatialUnit not found

NullArgumentException - assetId or spatialUnit is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization fauilure

Compliance:

mandatory - This method must be implemented.