Interface LocaleProxyManager

All Superinterfaces:

AutoCloseable, Closeable, LocaleProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface LocaleProxyManager
extends OsidProxyManager, LocaleProfile

The locale manager provides access to locale sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for passing information from server environments. The sessions included in this manager are:

• TranslationSession : a session translate strings
• TranslationAdminSession: a session to update the string translations for a locale
• NumericFormattingSession : a session for formatting and parsing numbers
• CalendarFormattingSession : a session for formatting and parsing dates and times
• CurrencyFormattingSession : a session for formatting and parsing currency amounts
• CoordinateFormattingSession : a session for formatting and parsing coordinates
• UnitConversionSession : a session to convert measurement units
• CurrencyConversionSession: a session to convert currency
• CalendarConversionSession : a session to convert dates across calendars
• CoordinateConversionSession : a session to convert coordinate systems
• SpatialUnitConversionSession : a session to convert spatial units
• FormatConversionSession : a session to convert text formats
• CalendarInfoSession : a session for examining calendaring and time systems

Method Summary

Modifier and Type	Method	Description
CalendarConversionSession	getCalendarConversionSession(Proxy proxy)	Gets a calendar conversion session.
CalendarConversionSession	getCalendarConversionSessionForType(Type sourceCalendarType, Type sourceTimeType, Type targetCalendarType, Type targetTimeType, Proxy proxy)	Gets an OsidSession associated with the calendar conversion service and the given calendar types.
CalendarFormattingSession	getCalendarFormattingSession(Proxy proxy)	Gets an OsidSession associated with the calendar formatting service.
CalendarFormattingSession	getCalendarFormattingSessionForType(Type calendarType, Type calendarFormatType, Type timeType, Type timeFormatType, Proxy proxy)	Gets an OsidSession associated with the calendar formatting service and the given calendar and time types.
CalendarInfoSession	getCalendarInfoSession(Proxy proxy)	Gets a calendar informational session session.
CalendarInfoSession	getCalendarInfoSessionForType(Type calendarType, Type timeType, Proxy proxy)	Gets an OsidSession associated with the calendar informational service and the given calendar and time types.
CoordinateConversionSession	getCoordinateConversionSession(Proxy proxy)	Gets a coordinate conversion session.
CoordinateConversionSession	getCoordinateConversionSessionForType(Type sourceCoordinateType, Type targetCoordinateType, Proxy proxy)	Gets an OsidSession associated with the coordinate conversion service and the given coordinate types.
CoordinateFormattingSession	getCoordinateFormattingSession(Proxy proxy)	Gets an OsidSession associated with the coordinate formatting service.
CoordinateFormattingSession	getCoordinateFormattingSessionForType(Type coordinateType, Type coordinateFormatType, Proxy proxy)	Gets an OsidSession associated with the coordinate formatting service and the given coordinate and format types.
CurrencyConversionSession	getCurrencyConversionSession(Proxy proxy)	Gets a currency conversion session.
CurrencyConversionSession	getCurrencyConversionSessionForType(Type sourceCurrencyType, Type targetCurrencyType, Proxy proxy)	Gets an OsidSession associated with the currency conversion service and the given currency types.
CurrencyFormattingSession	getCurrencyFormattingSession(Proxy proxy)	Gets an OsidSession associated with the currency formatting service.
CurrencyFormattingSession	getCurrencyFormattingSessionForType(Type currencyType, Type numericFormatType, Proxy proxy)	Gets an OsidSession associated with the currency formatting service and the given currency and numeric format types.
FormatConversionSession	getFormatConversionSession(Proxy proxy)	Gets a text format conversion session.
FormatConversionSession	getFormatConversionSessionForType(Type sourceFormatType, Type targetFormatType, Proxy proxy)	Gets an OsidSession associated with the text format conversion service and the given format types.
NumericFormattingSession	getNumericFormattingSession(Proxy proxy)	Gets an OsidSession associated with the numeric formatting service.
NumericFormattingSession	getNumericFormattingSessionForType(Type numericFormatType, Proxy proxy)	Gets an OsidSession associated with the numeric formatting service and the given numeric format type.
SpatialUnitConversionSession	getSpatialUnitConversionSession(Proxy proxy)	Gets a spatial unit conversion session.
SpatialUnitConversionSession	getSpatialUnitConversionSessionForType(Type sourceSpatialUnitRecordType, Type targetSpatialUnitRecordType, Proxy proxy)	Gets an OsidSession associated with the spatial unit conversion service and the given spatial unit record types.
TranslationAdminSession	getTranslationAdminSession(Proxy proxy)	Gets a language translation administration service for updating a locale dictionary.
TranslationAdminSession	getTranslationAdminSessionForType(Type sourceLanguageType, Type sourceScriptType, Type targetLanguageType, Type targetScriptType, Proxy proxy)	Gets a language trabslation administration service for updating a locale dictionary using the given language and script types.
TranslationSession	getTranslationSession(Proxy proxy)	Gets an OsidSession associated with the language translation service.
TranslationSession	getTranslationSessionForType(Type sourceLanguageType, Type sourceScriptType, Type targetLanguageType, Type targetScriptType, Proxy proxy)	Gets an OsidSession associated with the language translation service and the given language and script types.
UnitConversionSession	getUnitConversionSession(Proxy proxy)	Gets a unit conversion session.

Methods inherited from interface Closeable

close

Methods inherited from interface LocaleProfile

getCalendarTypesForFormatting, getCalendarTypesForSource, getCalendarTypesForTimeType, getCoordinateFormatTypesForCoordinateType, getCoordinateTypesForFormatting, getCoordinateTypesForSource, getCurrencyFormatTypesForCurrencyType, getCurrencyTypesForFormatting, getCurrencyTypesForSource, getDateFormatTypesForCalendarType, getFormatTypesForSource, getLanguageTypesForSource, getNumericFormatTypes, getScriptTypesForLanguageType, getSourceCalendarTypes, getSourceCoordinateTypes, getSourceCurrencyTypes, getSourceFormatTypes, getSourceLanguageTypes, getSourceSpatialUnitRecordTypes, getSourceTimeTypes, getSourceUnitTypes, getSpatialUnitRecordTypesForSource, getTimeFormatTypesForTimeType, getTimeTypesForCalendarType, getTimeTypesForFormatting, getTimeTypesForSource, getUnitTypesForSource, supportsCalendarConversion, supportsCalendarFormatting, supportsCalendarInfo, supportsCalendarTimeTypes, supportsCalendarTypesForConversion, supportsCalendarTypesForFormatting, supportsCoordinateConversion, supportsCoordinateFormatting, supportsCoordinateTypesForConversion, supportsCoordinateTypesForFormatting, supportsCurrencyConversion, supportsCurrencyFormatting, supportsCurrencyTypesForConversion, supportsCurrencyTypesForFormatting, supportsFormatConversion, supportsFormatTypesForConversion, supportsLanguageTypesForTranslation, supportsNumericFormatting, supportsNumericFormatTypes, supportsSpatialUnitConversion, supportsSpatialUnitRecordTypesForConversion, supportsTimeTypesForConversion, supportsTranslation, supportsTranslationAdmin, supportsUnitConversion, supportsUnitTypesForConversion, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getCalendarTypesForFormatting()	Gets all the calendar types for which formats are available.
TypeList	getCalendarTypesForSource(Type sourceCalendarType)	Gets the list of target calendar types for a given source calendar type.
TypeList	getCalendarTypesForTimeType(Type timeType)	Gets the list of calendar types supported for a given time type where they are both used in a DateTime .
TypeList	getCoordinateFormatTypesForCoordinateType(Type coordinateType)	Gets the list of coordinate format types for a given coordinate type.
TypeList	getCoordinateTypesForFormatting()	Gets all the coordinate types for which formatting is available.
TypeList	getCoordinateTypesForSource(Type sourceCoordinateType)	Gets the list of target coordinate types for a given source coordinate type.
TypeList	getCurrencyFormatTypesForCurrencyType(Type currencyType)	Gets the list of currency format types for a given currency type.
TypeList	getCurrencyTypesForFormatting()	Gets all the currency types for which formatting is available.
TypeList	getCurrencyTypesForSource(Type sourceCurrencyType)	Gets the list of target currency types for a given source currency type.
TypeList	getDateFormatTypesForCalendarType(Type calendarType)	Gets the list of date format types for a given calendar type.
TypeList	getFormatTypesForSource(Type sourceFormatType)	Gets the list of target format types for a given source spatial unit type.
TypeList	getLanguageTypesForSource(Type sourceLanguageType, Type sourceScriptType)	Gets the list of target language types for a given source language type.
TypeList	getNumericFormatTypes()	Gets all the numeric format types supported.
TypeList	getScriptTypesForLanguageType(Type languageType)	Gets the list of script types available for a given language type.
TypeList	getSourceCalendarTypes()	Gets the list of source calendar types.
TypeList	getSourceCoordinateTypes()	Gets the list of source coordinate types.
TypeList	getSourceCurrencyTypes()	Gets the list of source currency types.
TypeList	getSourceFormatTypes()	Gets the list of source format types.
TypeList	getSourceLanguageTypes()	Gets all the source language types supported.
TypeList	getSourceSpatialUnitRecordTypes()	Gets the list of source spatial unit record types.
TypeList	getSourceTimeTypes()	Gets the list of source time types.
TypeList	getSourceUnitTypes()	Gets all the source unit types supported.
TypeList	getSpatialUnitRecordTypesForSource(Type sourceSpatialUnitRecordType)	Gets the list of target spatial unit types for a given source spatial unit type.
TypeList	getTimeFormatTypesForTimeType(Type timeType)	Gets the list of time format types for a given time type.
TypeList	getTimeTypesForCalendarType(Type calendarType)	Gets the list of time types supported for a given calendar type where they are both used in a DateTime .
TypeList	getTimeTypesForFormatting()	Gets all the time types for which formatting is available.
TypeList	getTimeTypesForSource(Type sourceTimeType)	Gets the list of target time types for a given source time type.
TypeList	getUnitTypesForSource(Type sourceUnitType)	Gets the list of target measure types for a given source measure type.
boolean	supportsCalendarConversion()	Tests if calendar conversion is supported.
boolean	supportsCalendarFormatting()	Tests if calendar formatting is supported.
boolean	supportsCalendarInfo()	Tests if a calendar informational service is supported.
boolean	supportsCalendarTimeTypes(Type calendarType, Type timeType)	Tests if a given calendar and time type are used together in a DateTime .
boolean	supportsCalendarTypesForConversion(Type sourceCalendarType, Type targetCalendarType)	Tests if a given calendar conversion is supported.
boolean	supportsCalendarTypesForFormatting(Type calendarType, Type timeType, Type dateFormatType, Type timeFormatType)	Tests if a given calendaring formatting is supported.
boolean	supportsCoordinateConversion()	Tests if coordnate conversion is supported.
boolean	supportsCoordinateFormatting()	Tests if coordinate formatting is supported.
boolean	supportsCoordinateTypesForConversion(Type sourceCoordinateType, Type targetCoordinateType)	Tests if a given coordinate type for conversion is supported.
boolean	supportsCoordinateTypesForFormatting(Type coordinateType, Type coordinateFormatType)	Tests if a given coordinate formatting is supported.
boolean	supportsCurrencyConversion()	Tests if currency conversion is supported.
boolean	supportsCurrencyFormatting()	Tests if currency formatting is supported.
boolean	supportsCurrencyTypesForConversion(Type sourceCurrencyType, Type targetCurrencyType)	Tests if a given currency conversion is supported.
boolean	supportsCurrencyTypesForFormatting(Type currencyType, Type numericFormatType)	Tests if a given currency formatting is supported.
boolean	supportsFormatConversion()	Tests if format conversion is supported.
boolean	supportsFormatTypesForConversion(Type sourceFormatType, Type targetFormatType)	Tests if a given format conversion is supported.
boolean	supportsLanguageTypesForTranslation(Type sourceLanguageType, Type sourceScriptType, Type targetLanguageType, Type targetScriptType)	Tests if a given language translation is supported.
boolean	supportsNumericFormatting()	Tests if numeric formatting is supported.
boolean	supportsNumericFormatTypes(Type numericFormatType)	Tests if a given numeric format type is supported.
boolean	supportsSpatialUnitConversion()	Tests if spatial unit conversion is supported.
boolean	supportsSpatialUnitRecordTypesForConversion(Type sourceSpatialUnitRecordType, Type targetSpatialUnitRecordType)	Tests if a given spatial unit conversion is supported.
boolean	supportsTimeTypesForConversion(Type sourceTimeType, Type targetTimeType)	Tests if a given time conversion is supported.
boolean	supportsTranslation()	Tests if translation is supported.
boolean	supportsTranslationAdmin()	Tests if translation administration is supported.
boolean	supportsUnitConversion()	Tests if unit conversion is supported.
boolean	supportsUnitTypesForConversion(Type sourceUnitType, Type targetUnitType)	Tests if a given measure conversion is supported.
boolean	supportsVisibleFederation()	Tests if visible federation is supported.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getTranslationSession

TranslationSession getTranslationSession(Proxy proxy)
                                  throws OperationFailedException

Gets an OsidSession associated with the language translation service.

Parameters:

proxy - a proxy

Returns:

a TranslationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTranslation() is false

Compliance:

optional - This method must be implemented if {@code supportsTranslation()} is {@code true} .

getTranslationSessionForType

TranslationSession getTranslationSessionForType(Type sourceLanguageType,
 Type sourceScriptType,
 Type targetLanguageType,
 Type targetScriptType,
 Proxy proxy)
                                         throws OperationFailedException

Gets an OsidSession associated with the language translation service and the given language and script types.

Parameters:

sourceLanguageType - the type of the source language

sourceScriptType - the type of the source script

targetLanguageType - the type of the target language

targetScriptType - the type of the target script

proxy - a proxy

Returns:

a TranslationSession

Throws:

NullArgumentException - sourceLanguageType, sourceScriptType, targetLanguageType, targetScriptType or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTranslation() or supportsVisibleFederation() is false

UnsupportedException - supportsLanguageTypesForTranslation(sourceLanguageType, sourceScriptType, targetLanguageType, targetScriptType) is false

Compliance:

optional - This method must be implemented if {@code supportsTranslation()} and {@code supportsVisibleFederation()} are {@code true} .

getTranslationAdminSession

TranslationAdminSession getTranslationAdminSession(Proxy proxy)
                                            throws OperationFailedException

Gets a language translation administration service for updating a locale dictionary.

Parameters:

proxy - a proxy

Returns:

a TranslationAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTranslationAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsTranslationAdmin()} is {@code true} .

getTranslationAdminSessionForType

TranslationAdminSession getTranslationAdminSessionForType(Type sourceLanguageType,
 Type sourceScriptType,
 Type targetLanguageType,
 Type targetScriptType,
 Proxy proxy)
                                                   throws OperationFailedException

Gets a language trabslation administration service for updating a locale dictionary using the given language and script types.

Parameters:

sourceLanguageType - the type of the source language

sourceScriptType - the type of the source script

targetLanguageType - the type of the target language

targetScriptType - the type of the target script

proxy - a proxy

Returns:

a TranslationAdminSession

Throws:

NullArgumentException - sourceLanguageType, sourceScriptType, targetLanguageType, targetScriptType or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTranslationAdmin() or supportsVisibleFederation() is false

UnsupportedException - supportsLanguageTypesForTranslation(sourceLanguageType, sourceScriptType, targetLanguageType, targetScriptType) is false

Compliance:

optional - This method must be implemented if {@code supportsTranslationAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getNumericFormattingSession

NumericFormattingSession getNumericFormattingSession(Proxy proxy)
                                              throws OperationFailedException

Gets an OsidSession associated with the numeric formatting service.

Parameters:

proxy - a proxy

Returns:

a NumericFormattingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNumericFormatting() is false

Compliance:

optional - This method must be implemented if {@code supportsNumericFormatting()} is {@code true} .

getNumericFormattingSessionForType

NumericFormattingSession getNumericFormattingSessionForType(Type numericFormatType,
 Proxy proxy)
                                                     throws OperationFailedException

Gets an OsidSession associated with the numeric formatting service and the given numeric format type.

Parameters:

numericFormatType - the type of the numeric format

proxy - a proxy

Returns:

a NumericFormattingSession

Throws:

NullArgumentException - numericFormatType or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsNumericFormatting() or supportsVisibleFederation() is false

UnsupportedException - supportsNumericFormatType(numericFormatType) is false

Compliance:

optional - This method must be implemented if {@code supportsNumericFormatting()} and {@code supportsVisibleFederation()} are {@code true} .

getCalendarFormattingSession

CalendarFormattingSession getCalendarFormattingSession(Proxy proxy)
                                                throws OperationFailedException

Gets an OsidSession associated with the calendar formatting service.

Parameters:

proxy - a proxy

Returns:

a CalendarFormattingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarFormatting() is false

Compliance:

optional - This method must be implemented if {@code supportsCalendarFormatting()} is {@code true} .

getCalendarFormattingSessionForType

CalendarFormattingSession getCalendarFormattingSessionForType(Type calendarType,
 Type calendarFormatType,
 Type timeType,
 Type timeFormatType,
 Proxy proxy)
                                                       throws OperationFailedException

Gets an OsidSession associated with the calendar formatting service and the given calendar and time types.

Parameters:

calendarType - the type of the calendar

calendarFormatType - the type of the calendar format

timeType - the type of the time system

timeFormatType - the type of the time format

proxy - a proxy

Returns:

a CalendarFormattingSession

Throws:

NullArgumentException - calendarType, calendarFormatType, timeTyp, timeFormatType or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarFormatting() or supportsVisibleFederation() is false

UnsupportedException - supportsCalendarTypesForFormattinge(calendarType, calendarFormatType, timeType, timeFormatType) is false

Compliance:

optional - This method must be implemented if {@code supportsCalendarFormatting()} and {@code supportsVisibleFederation()} are {@code true} .

getCurrencyFormattingSession

CurrencyFormattingSession getCurrencyFormattingSession(Proxy proxy)
                                                throws OperationFailedException

Gets an OsidSession associated with the currency formatting service.

Parameters:

proxy - a proxy

Returns:

a CurrencyFormattingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCurrencyFormatting() is false

Compliance:

optional - This method must be implemented if {@code supportsCurrencyFormatting()} is {@code true} .

getCurrencyFormattingSessionForType

CurrencyFormattingSession getCurrencyFormattingSessionForType(Type currencyType,
 Type numericFormatType,
 Proxy proxy)
                                                       throws OperationFailedException

Gets an OsidSession associated with the currency formatting service and the given currency and numeric format types.

Parameters:

currencyType - the type of the currency

numericFormatType - the type of the numeric format

proxy - a proxy

Returns:

a CurrencyFormattingSession

Throws:

NullArgumentException - currencyType, numericFormatType or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCurrencyFormatting() or supportsVisibleFederation() is false

UnsupportedException - supportsCurrencyTypesForFomatting(currencyType, numericFormatType) is false

Compliance:

optional - This method must be implemented if {@code supportsCurrencyFormatting()} and {@code supportsVisibleFederation()} are {@code true} .

getCoordinateFormattingSession

CoordinateFormattingSession getCoordinateFormattingSession(Proxy proxy)
                                                    throws OperationFailedException

Gets an OsidSession associated with the coordinate formatting service.

Parameters:

proxy - a proxy

Returns:

a CoordinateFormattingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCoordinateFormatting() is false

Compliance:

optional - This method must be implemented if {@code supportsCoordinateFormatting()} is {@code true} .

getCoordinateFormattingSessionForType

CoordinateFormattingSession getCoordinateFormattingSessionForType(Type coordinateType,
 Type coordinateFormatType,
 Proxy proxy)
                                                           throws OperationFailedException

Gets an OsidSession associated with the coordinate formatting service and the given coordinate and format types.

Parameters:

coordinateType - the type of the coordinate

coordinateFormatType - the type of the coordinate format

proxy - a proxy

Returns:

a CoordinateFormattingSession

Throws:

NullArgumentException - coordinateType, coordinateFormatType ,or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCoordinateFormatting() or supportsVisibleFederation() is false

UnsupportedException - supportsCoordinateTypesForFomatting(coordinateType, coordinateFormatType) is false

Compliance:

optional - This method must be implemented if {@code supportsCoordinateFormatting()} and {@code supportsVisibleFederation()} are {@code true} .

getUnitConversionSession

UnitConversionSession getUnitConversionSession(Proxy proxy)
                                        throws OperationFailedException

Gets a unit conversion session.

Parameters:

proxy - a proxy

Returns:

a UnitConversionSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsUnitConversion() is false

Compliance:

optional - This method must be implemented if {@code supportsUnitConversion()} is {@code true} .

getCurrencyConversionSession

CurrencyConversionSession getCurrencyConversionSession(Proxy proxy)
                                                throws OperationFailedException

Gets a currency conversion session.

Parameters:

proxy - a proxy

Returns:

a CurrencyConversionSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCurrencyConversion() is false

Compliance:

optional - This method must be implemented if {@code supportsCurrencyConversion()} is {@code true} .

getCurrencyConversionSessionForType

CurrencyConversionSession getCurrencyConversionSessionForType(Type sourceCurrencyType,
 Type targetCurrencyType,
 Proxy proxy)
                                                       throws OperationFailedException

Gets an OsidSession associated with the currency conversion service and the given currency types.

Parameters:

sourceCurrencyType - the type of the source currency

targetCurrencyType - the type of the target currency

proxy - a proxy

Returns:

a CurrencyConversionSession

Throws:

NullArgumentException - sourceCurrencyType, targetCurrencyType or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCurrencyConversion() or supportsVisibleFederation() is false

UnsupportedException - supportsCurrencyTypesForConversion(sourceCurrencyType, targetCurrencyType) is false

Compliance:

optional - This method must be implemented if {@code supportsCurrencyConversion()} and {@code supportsVisibleFederation()} are {@code true} .

getCalendarConversionSession

CalendarConversionSession getCalendarConversionSession(Proxy proxy)
                                                throws OperationFailedException

Gets a calendar conversion session.

Parameters:

proxy - a proxy

Returns:

a CalendarConversionSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarConversion() is false

Compliance:

optional - This method must be implemented if {@code supportsCalendarConversion()} is {@code true} .

getCalendarConversionSessionForType

CalendarConversionSession getCalendarConversionSessionForType(Type sourceCalendarType,
 Type sourceTimeType,
 Type targetCalendarType,
 Type targetTimeType,
 Proxy proxy)
                                                       throws OperationFailedException

Gets an OsidSession associated with the calendar conversion service and the given calendar types.

Parameters:

sourceCalendarType - the type of the source calendar

sourceTimeType - the type of the source time

targetCalendarType - the type of the target calendar

targetTimeType - the type of the target time

proxy - a proxy

Returns:

a CalendarConversionSession

Throws:

NullArgumentException - sourceCalendarType, sourceTimeType, targetCalendarType, targetTimeType or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarConversion() or supportsVisibleFederation() is false

UnsupportedException - supportsCalendarTypesForConversion(sourceCalendarType, targetCalendarType) or supportsTimeTypesForConversion(sourceTimeType, targetTimeType) is false

Compliance:

optional - This method must be implemented if {@code supportsCalendarConversion()} and {@code supportsVisibleFederation()} are {@code true} .

getCoordinateConversionSession

CoordinateConversionSession getCoordinateConversionSession(Proxy proxy)
                                                    throws OperationFailedException

Gets a coordinate conversion session.

Parameters:

proxy - a proxy

Returns:

a CoordinateConversionSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCoordinateConversion() is false

Compliance:

optional - This method must be implemented if {@code supportsCoordinateConversion()} is {@code true} .

getCoordinateConversionSessionForType

CoordinateConversionSession getCoordinateConversionSessionForType(Type sourceCoordinateType,
 Type targetCoordinateType,
 Proxy proxy)
                                                           throws OperationFailedException

Gets an OsidSession associated with the coordinate conversion service and the given coordinate types.

Parameters:

sourceCoordinateType - the type of the source coordinate

targetCoordinateType - the type of the target coordinate

proxy - a proxy

Returns:

a CoordinateConversionSession

Throws:

NullArgumentException - sourceCoordinateType , targetCoordinateType , or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCoordinateConversion() or supportsVisibleFederation() is false

UnsupportedException - supportsCoordinateRecordTypesForConversion(sourceCoordinateType, targetCoordinateType) is false

Compliance:

optional - This method must be implemented if {@code supportsCoordinateConversion()} and {@code supportsVisibleFederation()} are {@code true} .

getSpatialUnitConversionSession

SpatialUnitConversionSession getSpatialUnitConversionSession(Proxy proxy)
                                                      throws OperationFailedException

Gets a spatial unit conversion session.

Parameters:

proxy - a proxy

Returns:

a SpatialUnitConversionSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpatialUnitConversion() is false

Compliance:

optional - This method must be implemented if {@code supportsSpatialUnitConversion()} is {@code true} .

getSpatialUnitConversionSessionForType

SpatialUnitConversionSession getSpatialUnitConversionSessionForType(Type sourceSpatialUnitRecordType,
 Type targetSpatialUnitRecordType,
 Proxy proxy)
                                                             throws OperationFailedException

Gets an OsidSession associated with the spatial unit conversion service and the given spatial unit record types.

Parameters:

sourceSpatialUnitRecordType - the type of the source spatial unit record

targetSpatialUnitRecordType - the type of the target spatial unit record

proxy - a proxy

Returns:

a SpatialUnitConversionSession

Throws:

NullArgumentException - sourceSpatialUnitRecordType , targetSpatialUnitRecordType or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpatialUnitConversion() or supportsVisibleFederation() is false

UnsupportedException - supportsSpatialUnitRecordTypesForConversion(sourceSpatialUnitRecordType, targetSpatialUnitRecordType) is false

Compliance:

optional - This method must be implemented if {@code supportsSpatialUnitConversion()} and {@code supportsVisibleFederation()} are {@code true} .

getFormatConversionSession

FormatConversionSession getFormatConversionSession(Proxy proxy)
                                            throws OperationFailedException

Gets a text format conversion session.

Parameters:

proxy - a proxy

Returns:

a FormatConversionSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFormatConversion() is false

Compliance:

optional - This method must be implemented if {@code supportsFormatConversion()} is {@code true} .

getFormatConversionSessionForType

FormatConversionSession getFormatConversionSessionForType(Type sourceFormatType,
 Type targetFormatType,
 Proxy proxy)
                                                   throws OperationFailedException

Gets an OsidSession associated with the text format conversion service and the given format types.

Parameters:

sourceFormatType - the type of the text format

targetFormatType - the type of the text format

proxy - a proxy

Returns:

a FormatConversionSession

Throws:

NullArgumentException - sourceFormatType, targetFormatType or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFormatConversion() or supportsVisibleFederation() is false

UnsupportedException - supportsFormatTypesForConversion(sourceFormatType, targetFormatRecordType) is false

Compliance:

optional - This method must be implemented if {@code supportsFormatConversion()} and {@code supportsVisibleFederation()} are {@code true} .

getCalendarInfoSession

CalendarInfoSession getCalendarInfoSession(Proxy proxy)
                                    throws OperationFailedException

Gets a calendar informational session session.

Parameters:

proxy - a proxy

Returns:

a CalendarInfoSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarInfo() is false

Compliance:

optional - This method must be implemented if {@code supportsCalendarInfo()} is {@code true} .

getCalendarInfoSessionForType

CalendarInfoSession getCalendarInfoSessionForType(Type calendarType,
 Type timeType,
 Proxy proxy)
                                           throws OperationFailedException

Gets an OsidSession associated with the calendar informational service and the given calendar and time types.

Parameters:

calendarType - the type of the calendar

timeType - the type of the time system

proxy - a proxy

Returns:

a CalendarInfoSession

Throws:

NullArgumentException - calendarType, timeType or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCalendarType() or supportsVisibleFederation() is false

UnsupportedException - supportsCalendarTimeTypes(calendarType, timeType) is false

Compliance:

optional - This method must be implemented if {@code supportsCalendarInfo()} and {@code supportsVisibleFederation()} are {@code true} .