com.helger.photon.basic.app.request

Interface IRequestParameterHandler

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractRequestParameterHandlerNamed, RequestParameterHandlerURLParameter, RequestParameterHandlerURLPathNamed, RequestParameterHandlerURLPathOrdered

public interface IRequestParameterHandler
extends Serializable

Interface for extracting parameters from URLs.

Since:

7.0.2

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
com.helger.commons.url.SimpleURL	buildURL(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, String sBasePath, Locale aDisplayLocale, String sMenuItemID) Build a URL based on the passed base path and an optional list of parameters.
PhotonRequestParameters	getParametersFromRequest(com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope) Get all request parameters from the provided request.
PhotonRequestParameters	getParametersFromURL(com.helger.commons.url.ISimpleURL aURL) Get all request parameters from the provided URL.

Method Detail

getParametersFromRequest

@Nonnull
 @ReturnsMutableCopy
PhotonRequestParameters getParametersFromRequest(@Nonnull
                                                                                 com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope)

Get all request parameters from the provided request.

Parameters:

aRequestScope - The current request scope. May not be null.

Returns:

A non-null list of all parameters.

getParametersFromURL

@Nonnull
 @ReturnsMutableCopy
PhotonRequestParameters getParametersFromURL(@Nonnull
                                                                             com.helger.commons.url.ISimpleURL aURL)

Get all request parameters from the provided URL.

Parameters:

aURL - The URL to extract the parameters from. May not be null.

Returns:

A non-null list of all parameters.

buildURL

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

Build a URL based on the passed base path and an optional list of parameters.

Parameters:

aRequestScope - Current request scope. May be null.

sBasePath - The base path to use. May not be null and must NOT end with a "/".

aDisplayLocale - The display locale to use. May be null.

sMenuItemID - The menu item ID to use. May be null.

Returns:

The URL to use.