Interface | osid.locale.SpatialUnitConversionSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to convert spatial units. | ||
Method | getSourceSpatialUnitRecordType | ||
Description |
Gets the source spatial unit record type used in this session. | ||
Return | osid.type.Type | the source spatial unit record type | |
Compliance | mandatory | This method must be implemented. | |
Method | getTargetSpatialUnitRecordType | ||
Description |
Gets the target spatial unit record type used in this session. | ||
Return | osid.type.Type | the target spatial unit record type | |
Compliance | mandatory | This method must be implemented. | |
Method | canConvertSpatialUnits | ||
Description |
Tests if this user can perform spatial unit
conversions. 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
| ||
Return | boolean | false if conversion methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | convertSpatialUnit | ||
Description |
Converts a spatial unit. | ||
Parameters | osid.mapping.SpatialUnit | sourceSpatialUnit | the spatial unit to convert |
Return | osid.mapping.SpatialUnit | the resulting spatial unit | |
Errors | INVALID_ARGUMENT | sourceSpatialUnit.hasType(getSourceSpatialUnitRecordType())
is false | |
NULL_ARGUMENT | sourceSpatialUnit is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | convertSpatialUnits | ||
Description |
Converts spatial units. | ||
Parameters | osid.mapping.SpatialUnitList | sourceSpatialUnitList | the spatial units to convert |
Return | osid.mapping.SpatialUnitList | the resulting spatial units | |
Errors | INVALID_ARGUMENT | sourceSpatialUnit.hasType(getSourceSpatialUnitRecordType())
is false | |
NULL_ARGUMENT | sourceSpatialUnitList is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |