com.gwtplatform.dispatch.rpc.shared

Class BatchAction

java.lang.Object

com.gwtplatform.dispatch.rpc.shared.BatchAction

All Implemented Interfaces:

IsSerializable, Action<BatchResult>, HasSecured, TypedAction<BatchResult>

public abstract class BatchAction
extends Object
implements Action<BatchResult>

This provides a simple way to send multiple actions to be executed in sequence. If any fail, the rules for the BatchAction.OnException value provided in the constructor determine the outcome.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchAction.OnException BatchAction's enumeration of possible outcomes when there is an exception.

Field Summary

Fields inherited from interface com.gwtplatform.dispatch.rpc.shared.Action

DEFAULT_SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
BatchAction(BatchAction.OnException onException, Action<?>... actions) Constructs a new batch action, which will attempt to execute the provided list of actions in order.

Method Summary

Methods

Modifier and Type	Method and Description
Action<?>[]	getActions() The list of actions to execute.
BatchAction.OnException	getOnException() The expected behaviour if any of the sub-actions throw an exception.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.gwtplatform.dispatch.rpc.shared.Action

getServiceName

Methods inherited from interface com.gwtplatform.dispatch.shared.HasSecured

isSecured

Constructor Detail

BatchAction

public BatchAction(BatchAction.OnException onException,
           Action<?>... actions)

Constructs a new batch action, which will attempt to execute the provided list of actions in order. If there is a failure, it will follow the rules specified by onException.

Parameters:

onException - If there is an exception, specify the behaviour.

actions - The list of actions to execute.

Method Detail

getActions

public Action<?>[] getActions()

The list of actions to execute.

Returns:

The actions.

getOnException

public BatchAction.OnException getOnException()

The expected behaviour if any of the sub-actions throw an exception.

Returns:

The exception handling behaviour.