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 Modifier and Type | Method and 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.
|
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
TranslationSession getTranslationSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the language
translation service.proxy
- a proxy TranslationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTranslation()
is false
optional
- This method must be implemented if
supportsTranslation()
is true.
TranslationSession getTranslationSessionForType(Type sourceLanguageType, Type sourceScriptType, Type targetLanguageType, Type targetScriptType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the language
translation service and the given language and script types.sourceLanguageType
- the type of the source languagesourceScriptType
- the type of the source scripttargetLanguageType
- the type of the target languagetargetScriptType
- the type of the target scriptproxy
- a proxy TranslationSession
NullArgumentException
- sourceLanguageType,
sourceScriptType, targetLanguageType, targetScriptType
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTranslation()
or supportsVisibleFederation()
is
false
UnsupportedException
-
supportsLanguageTypesForTranslation(sourceLanguageType,
sourceScriptType, targetLanguageType, targetScriptType)
is false
optional
- This method must be implemented if
supportsTranslation()
and
supportsVisibleFederation()
are true.
TranslationAdminSession getTranslationAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy TranslationAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTranslationAdmin()
is false
optional
- This method must be implemented if
supportsTranslationAdmin()
is true.
TranslationAdminSession getTranslationAdminSessionForType(Type sourceLanguageType, Type sourceScriptType, Type targetLanguageType, Type targetScriptType, Proxy proxy) throws OperationFailedException
sourceLanguageType
- the type of the source languagesourceScriptType
- the type of the source scripttargetLanguageType
- the type of the target languagetargetScriptType
- the type of the target scriptproxy
- a proxy TranslationAdminSession
NullArgumentException
- sourceLanguageType,
sourceScriptType, targetLanguageType, targetScriptType
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTranslationAdmin()
or
supportsVisibleFederation()
is false
UnsupportedException
-
supportsLanguageTypesForTranslation(sourceLanguageType,
sourceScriptType, targetLanguageType, targetScriptType)
is false
optional
- This method must be implemented if
supportsTranslationAdmin()
and
supportsVisibleFederation()
are true.
NumericFormattingSession getNumericFormattingSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the numeric
formatting service.proxy
- a proxy NumericFormattingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsNumericFormatting()
is false
optional
- This method must be implemented if
supportsNumericFormatting()
is true.
NumericFormattingSession getNumericFormattingSessionForType(Type numericFormatType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the numeric
formatting service and the given numeric format type.numericFormatType
- the type of the numeric formatproxy
- a proxy NumericFormattingSession
NullArgumentException
- numericFormatType
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsNumericFormatting()
or
supportsVisibleFederation()
is false
UnsupportedException
-
supportsNumericFormatType(numericFormatType)
is
false
optional
- This method must be implemented if
supportsNumericFormatting()
and
supportsVisibleFederation()
are true.
CalendarFormattingSession getCalendarFormattingSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the calendar
formatting service.proxy
- a proxy CalendarFormattingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCalendarFormatting()
is false
optional
- This method must be implemented if
supportsCalendarFormatting()
is true.
CalendarFormattingSession getCalendarFormattingSessionForType(Type calendarType, Type calendarFormatType, Type timeType, Type timeFormatType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the calendar
formatting service and the given calendar and time types.calendarType
- the type of the calendarcalendarFormatType
- the type of the calendar formattimeType
- the type of the time systemtimeFormatType
- the type of the time formatproxy
- a proxy CalendarFormattingSession
NullArgumentException
- calendarType,
calendarFormatType, timeTyp, timeFormatType
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCalendarFormatting()
or
supportsVisibleFederation()
is false
UnsupportedException
-
supportsCalendarTypesForFormattinge(calendarType,
calendarFormatType, timeType, timeFormatType)
is
false
optional
- This method must be implemented if
supportsCalendarFormatting()
and
supportsVisibleFederation()
are true.
CurrencyFormattingSession getCurrencyFormattingSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the currency
formatting service.proxy
- a proxy CurrencyFormattingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCurrencyFormatting()
is false
optional
- This method must be implemented if
supportsCurrencyFormatting()
is true.
CurrencyFormattingSession getCurrencyFormattingSessionForType(Type currencyType, Type numericFormatType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the currency
formatting service and the given currency and numeric format types.currencyType
- the type of the currencynumericFormatType
- the type of the numeric formatproxy
- a proxy CurrencyFormattingSession
NullArgumentException
- currencyType,
numericFormatType
or proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCurrencyFormatting()
or
supportsVisibleFederation()
is false
UnsupportedException
-
supportsCurrencyTypesForFomatting(currencyType,
numericFormatType)
is false
optional
- This method must be implemented if
supportsCurrencyFormatting()
and
supportsVisibleFederation()
are true.
CoordinateFormattingSession getCoordinateFormattingSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the coordinate
formatting service.proxy
- a proxy CoordinateFormattingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCoordinateFormatting()
is false
optional
- This method must be implemented if
supportsCoordinateFormatting()
is true.
CoordinateFormattingSession getCoordinateFormattingSessionForType(Type coordinateType, Type coordinateFormatType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the coordinate
formatting service and the given coordinate and format types.coordinateType
- the type of the coordinatecoordinateFormatType
- the type of the coordinate formatproxy
- a proxy CoordinateFormattingSession
NullArgumentException
- coordinateType,
coordinateFormatType,
or proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCoordinateFormatting()
or
supportsVisibleFederation()
is false
UnsupportedException
-
supportsCoordinateTypesForFomatting(coordinateType,
coordinateFormatType)
is false
optional
- This method must be implemented if
supportsCoordinateFormatting()
and
supportsVisibleFederation()
are true.
UnitConversionSession getUnitConversionSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy UnitConversionSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsUnitConversion()
is false
optional
- This method must be implemented if
supportsUnitConversion()
is true.
CurrencyConversionSession getCurrencyConversionSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy CurrencyConversionSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCurrencyConversion()
is false
optional
- This method must be implemented if
supportsCurrencyConversion()
is true.
CurrencyConversionSession getCurrencyConversionSessionForType(Type sourceCurrencyType, Type targetCurrencyType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the currency
conversion service and the given currency types.sourceCurrencyType
- the type of the source currencytargetCurrencyType
- the type of the target currencyproxy
- a proxy CurrencyConversionSession
NullArgumentException
- sourceCurrencyType,
targetCurrencyType
or proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCurrencyConversion()
or
supportsVisibleFederation()
is false
UnsupportedException
-
supportsCurrencyTypesForConversion(sourceCurrencyType,
targetCurrencyType)
is false
optional
- This method must be implemented if
supportsCurrencyConversion()
and
supportsVisibleFederation()
are true.
CalendarConversionSession getCalendarConversionSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy CalendarConversionSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCalendarConversion()
is false
optional
- This method must be implemented if
supportsCalendarConversion()
is true.
CalendarConversionSession getCalendarConversionSessionForType(Type sourceCalendarType, Type sourceTimeType, Type targetCalendarType, Type targetTimeType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the calendar
conversion service and the given calendar types.sourceCalendarType
- the type of the source calendarsourceTimeType
- the type of the source timetargetCalendarType
- the type of the target calendartargetTimeType
- the type of the target timeproxy
- a proxy CalendarConversionSession
NullArgumentException
- sourceCalendarType,
sourceTimeType, targetCalendarType, targetTimeType
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCalendarConversion()
or
supportsVisibleFederation()
is false
UnsupportedException
-
supportsCalendarTypesForConversion(sourceCalendarType,
targetCalendarType)
or
supportsTimeTypesForConversion(sourceTimeType, targetTimeType)
is false
optional
- This method must be implemented if
supportsCalendarConversion()
and
supportsVisibleFederation()
are true.
CoordinateConversionSession getCoordinateConversionSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy CoordinateConversionSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCoordinateConversion()
is false
optional
- This method must be implemented if
supportsCoordinateConversion()
is true.
CoordinateConversionSession getCoordinateConversionSessionForType(Type sourceCoordinateType, Type targetCoordinateType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the coordinate
conversion service and the given coordinate types.sourceCoordinateType
- the type of the source coordinatetargetCoordinateType
- the type of the target coordinateproxy
- a proxy CoordinateConversionSession
NullArgumentException
- sourceCoordinateType,
targetCoordinateType,
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCoordinateConversion()
or
supportsVisibleFederation()
is false
UnsupportedException
-
supportsCoordinateRecordTypesForConversion(sourceCoordinateType,
targetCoordinateType)
is false
optional
- This method must be implemented if
supportsCoordinateConversion()
and
supportsVisibleFederation()
are true.
SpatialUnitConversionSession getSpatialUnitConversionSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy SpatialUnitConversionSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpatialUnitConversion()
is false
optional
- This method must be implemented if
supportsSpatialUnitConversion()
is true.
SpatialUnitConversionSession getSpatialUnitConversionSessionForType(Type sourceSpatialUnitRecordType, Type targetSpatialUnitRecordType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the spatial unit
conversion service and the given spatial unit record types.sourceSpatialUnitRecordType
- the type of the source spatial
unit recordtargetSpatialUnitRecordType
- the type of the target spatial
unit recordproxy
- a proxy SpatialUnitConversionSession
NullArgumentException
-
sourceSpatialUnitRecordType,
targetSpatialUnitRecordType or
proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpatialUnitConversion()
or
supportsVisibleFederation()
is false
UnsupportedException
-
supportsSpatialUnitRecordTypesForConversion(sourceSpatialUnitRecordType,
targetSpatialUnitRecordType)
is false
optional
- This method must be implemented if
supportsSpatialUnitConversion()
and
supportsVisibleFederation()
are true.
FormatConversionSession getFormatConversionSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy FormatConversionSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFormatConversion()
is false
optional
- This method must be implemented if
supportsFormatConversion()
is true.
FormatConversionSession getFormatConversionSessionForType(Type sourceFormatType, Type targetFormatType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the text format
conversion service and the given format types.sourceFormatType
- the type of the text formattargetFormatType
- the type of the text formatproxy
- a proxy FormatConversionSession
NullArgumentException
- sourceFormatType,
targetFormatType
or proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFormatConversion()
or
supportsVisibleFederation()
is false
UnsupportedException
-
supportsFormatTypesForConversion(sourceFormatType,
targetFormatRecordType)
is false
optional
- This method must be implemented if
supportsFormatConversion()
and
supportsVisibleFederation()
are true.
CalendarInfoSession getCalendarInfoSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy CalendarInfoSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCalendarInfo()
is false
optional
- This method must be implemented if
supportsCalendarInfo()
is true.
CalendarInfoSession getCalendarInfoSessionForType(Type calendarType, Type timeType, Proxy proxy) throws OperationFailedException
OsidSession
associated with the calendar
informational service and the given calendar and time types.calendarType
- the type of the calendartimeType
- the type of the time systemproxy
- a proxy CalendarInfoSession
NullArgumentException
- calendarType, timeType
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsCalendarType()
or supportsVisibleFederation()
is
false
UnsupportedException
-
supportsCalendarTimeTypes(calendarType, timeType)
is
false
optional
- This method must be implemented if
supportsCalendarInfo()
and
supportsVisibleFederation()
are true.