org.apache.commons.scaffold.util
Interface BizRequest

All Known Implementing Classes:

BizRequestImpl

public interface BizRequest

A helper bean used to encapsulate the runtime properties needed by a business service [org.apache.commons.scaffold.util.BizSevice].

This is a whitebox class that is meant to be extended with new properties to meet the requirements of a particular business service.

A number of base properties are provided to meet common needs.

• SessionLocale - A locale object for the client making this request.
• RemoteNode - The network address of the client making this request (or its proxy host).
• RemoteServer - A general-purpose Object that may be used by a business service to obtain a reference to other services (JBDC, JNDI, and so forth).
• Parameter - A general-purpose String that may be used to select a sub-service or pass other information to the service.

Version:

$Revision: 1.4 $ $Date: 2004/03/21 21:10:10 $

Field Summary

static java.lang.String	REMOTE_SERVER_KEY The session attribute key for our remote server object ["REMOTE_SERVER"].
static java.lang.String	SESSION_LOCALE_KEY The session attribute key for our session locale object ["SESSION_LOCALE"].

Method Summary

java.lang.String	getParameter() Return the parameter.
java.lang.Integer	getRemoteNode() Return the network address of the client for this bean instance.
java.lang.Object	getRemoteServer() The remote server object for this bean instance, if any.
java.util.Locale	getSessionLocale() Return the locale for this bean instance.
void	setParameter(java.lang.String parameter) Set the parameter.
void	setRemoteNode(java.lang.Integer remoteNode) Set the network address of the client for this bean instance.
void	setRemoteServer(java.lang.Object server) Set the remote server
void	setSessionLocale(java.util.Locale locale) Set the locale for this bean instance.
Messages	validate(java.lang.String parameter) Validate the properties that have been set for this business request, and return an Messages object that encapsulates any validation errors that have been found.

Field Detail

SESSION_LOCALE_KEY

public static final java.lang.String SESSION_LOCALE_KEY

The session attribute key for our session locale object ["SESSION_LOCALE"]. (Suggestion only, may be overridden by presentation framework

See Also:

Constant Field Values

REMOTE_SERVER_KEY

public static final java.lang.String REMOTE_SERVER_KEY

The session attribute key for our remote server object ["REMOTE_SERVER"]. (Suggestion only, may be overridden by presentation framework

See Also:

Constant Field Values

Method Detail

getSessionLocale

public java.util.Locale getSessionLocale()

Return the locale for this bean instance.

Returns:

the locale

setSessionLocale

public void setSessionLocale(java.util.Locale locale)

Set the locale for this bean instance.

Parameters:

locale - The new locale

getRemoteNode

public java.lang.Integer getRemoteNode()

Return the network address of the client for this bean instance.

Returns:

the network address.

setRemoteNode

public void setRemoteNode(java.lang.Integer remoteNode)

Set the network address of the client for this bean instance.

Parameters:

remoteNode - The new remoteNode.

getRemoteServer

public java.lang.Object getRemoteServer()

The remote server object for this bean instance, if any.

This is often an application-scope object that can be used to process a JDBC query or equivalent. By default, the ProcessAction will set this to any application scope object found under the key BaseAction.REMOTE_SERVER or to null.

Returns:

the remote server

setRemoteServer

public void setRemoteServer(java.lang.Object server)

Set the remote server

Parameters:

server - The new server

getParameter

public java.lang.String getParameter()

Return the parameter.

setParameter

public void setParameter(java.lang.String parameter)

Set the parameter.

Parameters:

parameter - The new parameter

validate

public Messages validate(java.lang.String parameter)

Validate the properties that have been set for this business request, and return an Messages object that encapsulates any validation errors that have been found. If no errors are found, return null or an Messages object with no recorded error messages.

Parameters:

parameter - A general purpose parameter