com.gwtplatform.dispatch.client.interceptor

Interface Interceptor<A,R>

Type Parameters:

A - action class.

R - result class.

All Known Implementing Classes:

AbstractInterceptor

public interface Interceptor<A,R>

Interceptor implementations base interface.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canExecute(TypedAction action) Ensures this intercepted call can be executed.
DispatchRequest	execute(A action, AsyncCallback<R> resultCallback, ExecuteCommand<A,R> executeCommand) Handles the specified action.
Class<A>	getActionType()

Method Detail

execute

DispatchRequest execute(A action,
                      AsyncCallback<R> resultCallback,
                      ExecuteCommand<A,R> executeCommand)

Handles the specified action.

If the interceptor makes asynchronous calls, it is recommended that you confirm that this request has not been cancelled after returning by calling DelegatingDispatchRequest#isPending() against the request parameter.

Parameters:

action - The action to execute.

resultCallback - The callback to use to communicate the result of the action. Unless the request is cancelled, you must invoke AsyncCallback.onSuccess(Object) on this callback once you have obtained the result. If any failure occurs call AsyncCallback.onFailure(Throwable).

executeCommand - Call ExecuteCommand.execute(Object, AsyncCallback) on this object to send the action over to the server. As a parameter you can pass resultCallback or your custom AsyncCallback if you want to process the result.

Returns:

A DispatchRequest object. Never return null, instead return a new CompletedDispatchRequest if you executed, cancelled or ignored the action.

getActionType

Class<A> getActionType()

Returns:

The type of action supported by this interceptor.

canExecute

boolean canExecute(TypedAction action)

Ensures this intercepted call can be executed.

Parameters:

action - the action to test against.

Returns:

true if this action can be executed, false if not.