public interface SpatialUnitConversionSession extends OsidSession
This session defines methods to convert spatial units.
Modifier and Type | Method and Description |
---|---|
boolean |
canConvertSpatialUnits()
Tests if this user can perform spatial unit conversions.
|
SpatialUnit |
convertSpatialUnit(SpatialUnit sourceSpatialUnit)
Converts a spatial unit.
|
SpatialUnitList |
convertSpatialUnits(SpatialUnitList sourceSpatialUnitList)
Converts spatial units.
|
Type |
getSourceSpatialUnitRecordType()
Gets the source spatial unit record type used in this session.
|
Type |
getTargetSpatialUnitRecordType()
Gets the target spatial unit record type used in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Type getSourceSpatialUnitRecordType()
mandatory
- This method must be implemented. Type getTargetSpatialUnitRecordType()
mandatory
- This method must be implemented. boolean canConvertSpatialUnits()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations. false
if conversion methods are not authorized,
true
otherwisemandatory
- This method must be implemented. SpatialUnit convertSpatialUnit(SpatialUnit sourceSpatialUnit) throws OperationFailedException, PermissionDeniedException
sourceSpatialUnit
- the spatial unit to convertInvalidArgumentException
-
sourceSpatialUnit.hasType(getSourceSpatialUnitRecordType())
is false
NullArgumentException
- sourceSpatialUnit
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SpatialUnitList convertSpatialUnits(SpatialUnitList sourceSpatialUnitList) throws OperationFailedException, PermissionDeniedException
sourceSpatialUnitList
- the spatial units to convertInvalidArgumentException
-
sourceSpatialUnit.hasType(getSourceSpatialUnitRecordType())
is false
NullArgumentException
- sourceSpatialUnitList
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.