org.apache.commons.scaffold.util
Interface BizResponse

All Known Implementing Classes:

BizResponseImpl

public interface BizResponse

Convenient wrapper for the result of a business process.

The result property returns any object generated by the process that is to be returned to the presentation tier. The messages property is a list of any confirmation messages to be displayed by the presentation tier. These may be keys into a resource bundle, or literal text, depending on whether the application is localized. The dispatchPath property returns any special advice regarding the next step in the workflow. Null indicates the nominal "success" path should be followed. The data property is any actual data returned from storage. This may be a single record or a collection of records (see isSingleForm()).

Version:

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

Method Summary

void	addMessage(Message message) Add a message to the list.
void	addMessage(Message message, java.lang.String property) Add a message to the list.
java.lang.Object	getData() Return the data object.
java.lang.String	getDispatch() The dispatch property can be used to re-route control to an non-default location, either as a system path or via a logical name (e.g ActionForward).
Messages	getMessages() Return the messages list.
java.lang.String	getName() Return the attribute name for the result object.
java.lang.String	getScope() Return the scope under which to store this result object.
boolean	isAggregate() Return whether the result of this ProcessResult is a collection of contains other ProcessResult objects to be handled individually.
boolean	isData() Return whether data object has been set.
boolean	isDispatch() Return whether dispatch advice has been set.
boolean	isDispatchPath() Return whether dispatch advice is suppose to be a true path or a logical name (e.g.
boolean	isExposed() Return the exposed state.
boolean	isMessages() Return whether there are any messages queued.
boolean	isSingleForm() Return the single-form state: list of 0 or more records=FALSE, exactly one record=TRUE.
void	setAggregate(boolean aggregate) Assign a new container state.
void	setData(java.lang.Object data) Assign a new data object.
void	setDispatch(java.lang.String dispatch) Field to store dispatch property.
void	setDispatchPath(boolean dispatchPath) Indicates whether dispatch advice (if any) is suppose to be a path or a logical name (e.g.
void	setExposed(boolean exposed) Indicates whether the result should be exposed to the rest of the application through a context.
void	setName(java.lang.String name) Set the attribute name for this result object.
void	setScope(java.lang.String scope) Set the scope under which to store this result object.
void	setSingleForm(boolean singleForm) Set the single-form state: list of 0 or more records=FALSE, exactly one record=TRUE.

Method Detail

getName

public java.lang.String getName()

Return the attribute name for the result object.

Typically, this will be set by the caller but is provided in case a special name must be used or a way is needed to distingish between result objects.

Returns:

the name

setName

public void setName(java.lang.String name)

Set the attribute name for this result object.

Parameters:

name - The new name

getScope

public java.lang.String getScope()

Return the scope under which to store this result object.

Returns:

the scope

setScope

public void setScope(java.lang.String scope)

Set the scope under which to store this result object.

Parameters:

scope - The new scope

isSingleForm

public boolean isSingleForm()

Return the single-form state: list of 0 or more records=FALSE, exactly one record=TRUE.

setSingleForm

public void setSingleForm(boolean singleForm)

Set the single-form state: list of 0 or more records=FALSE, exactly one record=TRUE.

isExposed

public boolean isExposed()

Return the exposed state.

Returns:

True if the result should be exposed

setExposed

public void setExposed(boolean exposed)

Indicates whether the result should be exposed to the rest of the application through a context.

getData

public java.lang.Object getData()

Return the data object.

setData

public void setData(java.lang.Object data)

Assign a new data object.

Parameters:

data - The new data object

isData

public boolean isData()

Return whether data object has been set.

isAggregate

public boolean isAggregate()

Return whether the result of this ProcessResult is a collection of contains other ProcessResult objects to be handled individually. This allows processes to be combined on the business tier and returned to controller as a single operation.

setAggregate

public void setAggregate(boolean aggregate)

Assign a new container state.

Parameters:

aggregate - Set to true for aggregate result

getMessages

public Messages getMessages()

Return the messages list.

isMessages

public boolean isMessages()

Return whether there are any messages queued.

addMessage

public void addMessage(Message message,
                       java.lang.String property)

Add a message to the list. Instantiate messages if it does not already exist.

addMessage

public void addMessage(Message message)

Add a message to the list. Instantiate messages if it does not already exist.

getDispatch

public java.lang.String getDispatch()

The dispatch property can be used to re-route control to an non-default location, either as a system path or via a logical name (e.g ActionForward).

See Also:

setDispatchPath()

setDispatch

public void setDispatch(java.lang.String dispatch)

Field to store dispatch property.

isDispatch

public boolean isDispatch()

Return whether dispatch advice has been set.

isDispatchPath

public boolean isDispatchPath()

Return whether dispatch advice is suppose to be a true path or a logical name (e.g. ActionForward)

setDispatchPath

public void setDispatchPath(boolean dispatchPath)

Indicates whether dispatch advice (if any) is suppose to be a path or a logical name (e.g. ActionForward).

Parameters:

dispatchPath - The new dispatch advice