RpcDispatchHooks.java

/*
 * Copyright 2014 ArcBees Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.gwtplatform.dispatch.rpc.client;

import com.gwtplatform.dispatch.rpc.shared.Action;
import com.gwtplatform.dispatch.rpc.shared.Result;

/**
 * Hooks to be executed on every {@link DispatchCall}.
 *
 * {@link RpcDispatchHooks#onExecute(Action, boolean)} will be called just before any action is attempted.<br>
 * {@link RpcDispatchHooks#onSuccess(Action, Result, boolean)} will be called when any action succeeds.<br>
 * {@link RpcDispatchHooks#onFailure(Action , Throwable, boolean)} will be called when any action fails.
 */
public interface RpcDispatchHooks {
    <R extends Result> void onExecute(Action<R> action, boolean undo);

    <R extends Result> void onSuccess(Action<R> action, R result, boolean undo);

    <R extends Result> void onFailure(Action<R> action, Throwable caught, boolean undo);
}