Interface UnitConversionSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface UnitConversionSession
extends OsidSession

This session defines methods to convert units across measurement systems.

Method Summary

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

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

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

BigDecimal convertUnit(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

BigDecimal[] convertUnits(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.