oracle.dss.thin.beans
Interface QueryParameterProvider

All Known Implementing Classes:

ServletQueryParameterProvider

public interface QueryParameterProvider

This interface that gets passed into ThinBeanUI's handleEvent() method

Method Summary

java.lang.String	getApplicationQueryParameter(java.lang.String name) Returns an application query parameter value from the current request's URL.
java.lang.String[]	getApplicationQueryParameterValues(java.lang.String name) Returns an application query parameter's values from the current request's URL.
java.lang.Object	getAttributeValue(java.lang.String name) Retrieve an attribute by name.
java.lang.String	getCharacterEncoding() Retrieve the character encoding.
javax.servlet.http.HttpServletRequest	getHttpServletRequest() Retrieve the current HttpServletRequest.
javax.servlet.http.HttpServletResponse	getHttpServletResponse() Retrieve the current HttpServletResponse
java.lang.String	getQueryParameter(java.lang.String name) Returns a query parameter value from the current request's URL.
java.lang.String[]	getQueryParameterValues(java.lang.String name) Returns a query parameter's values from the current request's URL.

Method Detail

getQueryParameter

public java.lang.String getQueryParameter(java.lang.String name)

Returns a query parameter value from the current request's URL. If the implementation of QueryParameterProvider has an HTTPServletRequest, then the query parameters can be fetched from the request using the getQueryParameter() method on the HTTPServletRequest.

It is the responsibility of the QueryParameterProvider to "encode"/transform the query parameter name using UIX Share's oracle.cabo.share.url.URLEncoder class before trying to fetch the query parameter from the HTTPServletRequest. The URLEncoder is used to isolate ThinBeanUI event parameter names from application query parameter names.

Note : Applications should use the getApplicationQueryParameter() method to retrieve application query parameters that were added to events via hidden form fields or EventTargets. This is due to the fact that application query parameters do not have their names encoded using a URLEncoder.

It is also the responsibility of the QueryParameterProvider to decode all query parameter values using the correct character set encoding. We recommend using the static oracle.cabo.share.util.CaboHttpUtils.decodeRequestParameter() method provided by to decode values.

Parameters:

name - the query parameter name

Returns:

if found, the query parameter value, if not found, then null

getQueryParameterValues

public java.lang.String[] getQueryParameterValues(java.lang.String name)

Returns a query parameter's values from the current request's URL. If the implementation of QueryParameterProvider has an HTTPServletRequest, then the query parameters can be fetched from the request using the getQueryParameterValues() method on the HTTPServletRequest.

It is the responsibility of the QueryParameterProvider to "encode"/transform the query parameter name using UIX Share's oracle.cabo.share.url.URLEncoder class before trying to fetch the query parameter from the HTTPServletRequest. The URLEncoder is used to isolate ThinBeanUI event parameter names from application query parameter names.

Note : Applications should use the getApplicationQueryParameter() method to retrieve application query parameters that were added to events via hidden form fields or EventTargets. This is due to the fact that application query parameters do not have their names encoded using a URLEncoder.

It is also the responsibility of the QueryParameterProvider to decode all query parameter values using the correct character set encoding. We recommend using the static oracle.cabo.share.util.CaboHttpUtils.decodeRequestParameter() method provided by to decode values.

Parameters:

name - the query parameter name

Returns:

if found, the query parameter values, if not found, then null

getApplicationQueryParameter

public java.lang.String getApplicationQueryParameter(java.lang.String name)

Returns an application query parameter value from the current request's URL. If the implementation of QueryParameterProvider has an HTTPServletRequest, then the query parameters can be fetched from the request using the getQueryParameter() method on the HTTPServletRequest.

Note : Applications should use this method to retrieve application query parameters that were added to events via hidden form fields or EventTargets.

It is also the responsibility of the QueryParameterProvider to decode all query parameter values using the correct character set encoding. We recommend using the static oracle.cabo.share.util.CaboHttpUtils.decodeRequestParameter() method provided by to decode values.

Parameters:

name - the query parameter name

Returns:

if found, the query parameter value, if not found, then null

getApplicationQueryParameterValues

public java.lang.String[] getApplicationQueryParameterValues(java.lang.String name)

Returns an application query parameter's values from the current request's URL. If the implementation of QueryParameterProvider has an HTTPServletRequest, then the query parameters can be fetched from the request using the getQueryParameter() method on the HTTPServletRequest.

Note : Applications should use this method to retrieve application query parameters that were added to events via hidden form fields or EventTargets.

It is also the responsibility of the QueryParameterProvider to decode all query parameter values using the correct character set encoding. We recommend using the static oracle.cabo.share.util.CaboHttpUtils.decodeRequestParameter() method provided by to decode values.

Parameters:

name - the query parameter name

Returns:

if found, the query parameter values, if not found, then null

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String name)

Retrieve an attribute by name. Thin bean event handlers use this method to fetch application supplied attributes. One example of an application supplied attribute is BIConstants.BICONTEXT_ATTR, which is used to pass the BI Beans Catalog context to a dataview's BIConstants.SAVE_EVENT event handler.

Returns:

an application attribute

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Retrieve the current HttpServletRequest. The HttpServletRequest is not used by thin bean event handlers, but it can be used by an application event handler if so desired. Therefore, this method can return null, if an application does not have access to or require an HttpServletRequest in their event handlers.

Returns:

the current HttpServletRequest

getHttpServletResponse

public javax.servlet.http.HttpServletResponse getHttpServletResponse()

Retrieve the current HttpServletResponse

Returns:

the current HttpServletResponse

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Retrieve the character encoding. Returns null if the default character encoding is used.

Returns:

the character encoding