org.osid.locale

Interface UnitConversionSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface UnitConversionSession
extends OsidSession

This session defines methods to convert units across measurement systems.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canConvertUnits() Tests if this user can perform unit conversions.
java.math.BigDecimal	convertUnit(java.math.BigDecimal sourceUnit, Type sourceUnitType, Type targetUnitType) Convert a unit of measurement.
java.math.BigDecimal[]	convertUnits(java.math.BigDecimal[] sourceUnits, Type sourceUnitType, Type targetUnitType) Convert units of measurement.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canConvertUnits

boolean canConvertUnits()

Tests if this user can perform 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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations.

Returns:

false if conversion methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

convertUnit

java.math.BigDecimal convertUnit(java.math.BigDecimal sourceUnit,
                               Type sourceUnitType,
                               Type targetUnitType)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Convert a unit of measurement.

Parameters:

sourceUnit - the measure to convert

sourceUnitType - the type of measure specified

targetUnitType - the type of converted measure

Returns:

resulting measure

Throws:

NullArgumentException - null argument provided

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - LocaleManager.supportsUnitTypesForConversion(measureType, conversionType) is false

Compliance:

mandatory - This method must be implemented.

convertUnits

java.math.BigDecimal[] convertUnits(java.math.BigDecimal[] sourceUnits,
                                  Type sourceUnitType,
                                  Type targetUnitType)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Convert units of measurement.

Parameters:

sourceUnits - the measures to convert

sourceUnitType - the type of measure specified

targetUnitType - the type of converted measure

Returns:

resulting measures

Throws:

NullArgumentException - null argument provided

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - LocaleManager.supportsUnitTypesForConversion(measureType, conversionType) is false

Compliance:

mandatory - This method must be implemented.