org.apache.commons.scaffold.util
Interface ProcessResult

All Known Implementing Classes:

ProcessResultBase

Deprecated. Use BizResponse instead

public interface ProcessResult

Convenient wrapper for the result of a 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: 155464 $ $Date: 2005-02-26 13:26:54 +0000 (Sat, 26 Feb 2005) $

Author:

Ted Husted, Synthis Corporation

Method Summary

boolean	addMessage(Object message) Deprecated. Add a message to the list.
Object	getData() Deprecated. Return the data object.
String	getDispatch() Deprecated. 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).
List	getMessages() Deprecated. Return the messages list.
String	getName() Deprecated. Return the attribute name for the result object.
String	getScope() Deprecated. Return the scope under which to store this result object.
boolean	isAggregate() Deprecated. Return whether the result of this ProcessResult is a collection of contains other ProcessResult objects to be handled individually.
boolean	isData() Deprecated. Return whether data object has been set.
boolean	isDispatch() Deprecated. Return whether dispatch advice has been set.
boolean	isDispatchPath() Deprecated. Return whether dispatch advice is suppose to be a true path or a logical name (e.g.
boolean	isExposed() Deprecated. Return the exposed state.
boolean	isMessages() Deprecated. Return whether there are any messages queued.
boolean	isSingleForm() Deprecated. Return the single-form state: list of 0 or more records=FALSE, exactly one record=TRUE.
void	setAggregate(boolean aggregate) Deprecated. Assign a new container state.
void	setData(Object data) Deprecated. Assign a new data object.
void	setDispatch(String dispatch) Deprecated. Field to store dispatch property.
void	setDispatchPath(boolean dispatchPath) Deprecated. Indicates whether dispatch advice (if any) is suppose to be a path or a logical name (e.g.
void	setExposed(boolean exposed) Deprecated. Indicates whether the result should be exposed to the rest of the application through a context.
void	setName(String name) Deprecated. Set the attribute name for this result object.
void	setScope(String scope) Deprecated. Set the scope under which to store this result object.
void	setSingleForm(boolean singleForm) Deprecated. Set the single-form state: list of 0 or more records=FALSE, exactly one record=TRUE.

Method Detail

getName

String getName()

Deprecated.

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

void setName(String name)

Deprecated.

Set the attribute name for this result object.

Parameters:

name - The new name

getScope

String getScope()

Deprecated.

Return the scope under which to store this result object.

Returns:

the scope

setScope

void setScope(String scope)

Deprecated.

Set the scope under which to store this result object.

Parameters:

scope - The new scope

isSingleForm

boolean isSingleForm()

Deprecated.

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

Returns:

True if this is a single record

setSingleForm

void setSingleForm(boolean singleForm)

Deprecated.

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

Parameters:

Set - to true for single form.

isExposed

boolean isExposed()

Deprecated.

Return the exposed state.

Returns:

True if the result should be exposed

setExposed

void setExposed(boolean exposed)

Deprecated.

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

Parameters:

multiple - The new exposed

getData

Object getData()

Deprecated.

Return the data object.

Returns:

The data object

setData

void setData(Object data)

Deprecated.

Assign a new data object.

Parameters:

data - The new data object

isData

boolean isData()

Deprecated.

Return whether data object has been set.

Returns:

True if this result contains a data object

isAggregate

boolean isAggregate()

Deprecated.

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.

Returns:

True if this ProcessResult contains other ProcessResults objects

setAggregate

void setAggregate(boolean aggregate)

Deprecated.

Assign a new container state.

Parameters:

aggregate - Set to true for aggregate result

getMessages

List getMessages()

Deprecated.

Return the messages list.

Returns:

The message list

isMessages

boolean isMessages()

Deprecated.

Return whether there are any messages queued.

Returns:

True if there are messages queued.

addMessage

boolean addMessage(Object message)

Deprecated.

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

Returns:

True if message added.

getDispatch

String getDispatch()

Deprecated.

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).

Returns:

The dispatch advice

See Also:

setDispatchPath()

setDispatch

void setDispatch(String dispatch)

Deprecated.

Field to store dispatch property.

isDispatch

boolean isDispatch()

Deprecated.

Return whether dispatch advice has been set.

Returns:

True if dispatch advice has been set.

isDispatchPath

boolean isDispatchPath()

Deprecated.

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

Returns:

True if dispatch advice is an actual path

setDispatchPath

void setDispatchPath(boolean dispatchPath)

Deprecated.

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