com.helger.photon.basic.app.request

Interface IRequestParameterManager

All Known Implementing Classes:

RequestParameterManager

public interface IRequestParameterManager

Predefined request parameter manager

Since:

7.0.2

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default com.helger.commons.url.SimpleURL	getLinkToMenuItem(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, Locale aDisplayLocale, String sMenuItemID)
com.helger.commons.url.SimpleURL	getLinkToMenuItem(String sAppID, com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, Locale aDisplayLocale, String sMenuItemID)
String	getLocaleFromURL(com.helger.commons.url.ISimpleURL aURL)
String	getMenuItemFromURL(com.helger.commons.url.ISimpleURL aURL)
IRequestParameterHandler	getParameterHandler()
default Locale	getRequestDisplayCountry() Get the country to be used for this request.
default String	getRequestDisplayLanguage()
Locale	getRequestDisplayLocale() Get the locale to be used for this request.
IMenuItemPage	getRequestMenuItem() Resolve the request parameter for the menu item to an IMenuItem object.
default String	getRequestMenuItemID()
Locale	getSessionDisplayLocale() Get the locale stored in the session.
IMenuItemPage	getSessionMenuItem()
void	onRequestBegin(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, String sApplicationID) To be called upon the beginning of each request.
void	setParameterHandler(IRequestParameterHandler aRequestParameterHdl)

Method Detail

getParameterHandler

@Nonnull
IRequestParameterHandler getParameterHandler()

setParameterHandler

void setParameterHandler(@Nonnull
                         IRequestParameterHandler aRequestParameterHdl)

onRequestBegin

void onRequestBegin(@Nonnull
                    com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope,
                    @Nonnull @Nonempty
                    String sApplicationID)

To be called upon the beginning of each request. Extracts the locale and menu item parameter from the request URL.

Parameters:

aRequestScope - The request scope that just begun. May not be null.

sApplicationID - The current application ID

getSessionMenuItem

@Nullable
IMenuItemPage getSessionMenuItem()

Returns:

The ID of the last requested menu item, or null if the corresponding session parameter is not present.

getRequestMenuItem

@Nonnull
IMenuItemPage getRequestMenuItem()

Resolve the request parameter for the menu item to an IMenuItem object. If no parameter is present, return the default menu item.

Returns:

The resolved menu item object from the request parameter. Never null.

getRequestMenuItemID

@Nonnull
default String getRequestMenuItemID()

Returns:

The ID of the current request menu item. May not be null.

getSessionDisplayLocale

@Nullable
Locale getSessionDisplayLocale()

Get the locale stored in the session. If neither request nor session data is present, the default locale is returned.

Returns:

May be null if neither session locale nor default locale is present.

getRequestDisplayLocale

@Nonnull
Locale getRequestDisplayLocale()

Get the locale to be used for this request. If no parameter is present, the one from the session is used. If neither request nor session data is present, the default locale is returned.

Returns:

The locale to be used for the current request. Never null.

getRequestDisplayCountry

@Nonnull
default Locale getRequestDisplayCountry()

Get the country to be used for this request. If no parameter is present, the one from the session is used. If neither request nor session data is present, the country of the default locale is returned.

Returns:

The country-Locale of the request display locale. Never null.

See Also:

getRequestDisplayLocale()

getRequestDisplayLanguage

@Nonnull
default String getRequestDisplayLanguage()

Returns:

The language name from the current request display locale. Never null.

See Also:

getRequestDisplayLocale()

getLinkToMenuItem

@Nonnull
default com.helger.commons.url.SimpleURL getLinkToMenuItem(@Nonnull
                                                                     com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope,
                                                                     @Nonnull
                                                                     Locale aDisplayLocale,
                                                                     @Nonnull
                                                                     String sMenuItemID)

getLinkToMenuItem

@Nonnull
com.helger.commons.url.SimpleURL getLinkToMenuItem(@Nonnull @Nonempty
                                                             String sAppID,
                                                             @Nonnull
                                                             com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope,
                                                             @Nonnull
                                                             Locale aDisplayLocale,
                                                             @Nonnull
                                                             String sMenuItemID)

getMenuItemFromURL

@Nullable
String getMenuItemFromURL(@Nullable
                                     com.helger.commons.url.ISimpleURL aURL)

getLocaleFromURL

@Nullable
String getLocaleFromURL(@Nullable
                                   com.helger.commons.url.ISimpleURL aURL)