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: 155464 $ $Date: 2005-02-26 13:26:54 +0000 (Sat, 26 Feb 2005) $

Author:

Ted Husted, Nationwide Insurance Company

Field Summary

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

Method Summary

String	getParameter() Return the parameter.
Integer	getRemoteNode() Return the network address of the client for this bean instance.
Object	getRemoteServer() The remote server object for this bean instance, if any.
Locale	getSessionLocale() Return the locale for this bean instance.
void	setParameter(String parameter) Set the parameter.
void	setRemoteNode(Integer remoteNode) Set the network address of the client for this bean instance.
void	setRemoteServer(Object server) Set the remote server
void	setSessionLocale(Locale locale) Set the locale for this bean instance.
Messages	validate(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

static final 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

static final 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

Locale getSessionLocale()

Return the locale for this bean instance.

Returns:

the locale

setSessionLocale

void setSessionLocale(Locale locale)

Set the locale for this bean instance.

Parameters:

locale - The new locale

getRemoteNode

Integer getRemoteNode()

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

Returns:

the network address.

setRemoteNode

void setRemoteNode(Integer remoteNode)

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

Parameters:

remoteNode - The new remoteNode.

getRemoteServer

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

void setRemoteServer(Object server)

Set the remote server

Parameters:

server - The new server

getParameter

String getParameter()

Return the parameter.

setParameter

void setParameter(String parameter)

Set the parameter.

Parameters:

parameter - The new parameter

validate

Messages validate(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