com.ibm.portal.state.accessors.locale
Interface LocaleAccessorFactory

All Superinterfaces:

AccessorFactory

public interface LocaleAccessorFactory
extends AccessorFactory

Factory that generates locale accessors. The locale information is optionally set on a state. A locale set in the state takes precedence over user preferred locales or locales defined on the users client browser.

Since:

6.0

Method Summary

LocaleAccessor	getLocaleAccessor(Node localeNode, DocumentModel model) Returns a read-only interface to the locale information under the assumption that the given root forms the root of the locale data in the document.
LocaleAccessor	getLocaleAccessor(StateHolder state) Returns a read-only interface to the locale information in the state holder.
LocaleAccessorController	getLocaleAccessorController(Node localeNode, DocumentController model) Returns a read-and-write interface to the locale information under the assumption that the given root forms the root of the locale data in the document.
LocaleAccessorController	getLocaleAccessorController(StateHolderController state) Returns a read-and-write interface to the locale information in the state holder.

Methods inherited from interface com.ibm.portal.state.accessors.AccessorFactory

compact

Method Detail

getLocaleAccessor

LocaleAccessor getLocaleAccessor(StateHolder state)

Returns a read-only interface to the locale information in the state holder. Use this method to get to the current locale of the state.
Note: During a request, the proper way to query for the current locale is to use the getLocale or getLocales methods.

Parameters:

state - State holder that contains the locale. Must not be null.

Returns:

Read-only accessor to the locale state. Not null.

getLocaleAccessor

LocaleAccessor getLocaleAccessor(Node localeNode,
                                 DocumentModel model)

Returns a read-only interface to the locale information under the assumption that the given root forms the root of the locale data in the document. Use this method if you moved the locale within the document hierarchy.

Parameters:

localeNode - Root node for selection information. Must not be null.

model - Model that contains the root. Must not be null.

Returns:

Read-only accessor to the locale state. Not null.

getLocaleAccessorController

LocaleAccessorController getLocaleAccessorController(StateHolderController state)

Returns a read-and-write interface to the locale information in the state holder. Use this method to set the current locale of the state.

Parameters:

state - State holder controller that contains the locale and allows to modify it. Must not be null.

Returns:

Read-write accessor to the locale state. Not null.

getLocaleAccessorController

LocaleAccessorController getLocaleAccessorController(Node localeNode,
                                                     DocumentController model)

Returns a read-and-write interface to the locale information under the assumption that the given root forms the root of the locale data in the document.

Parameters:

localeNode - Root node for selection information. Must not be null.

model - Model that contains the root. Must not be null.

Returns:

Read-write accessor to the locale state. Not null.