com.gwtplatform.dispatch.client.interceptor.ExecuteCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gwtp-all Show documentation

The newest version!

/*
 * Copyright 2013 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.client.interceptor;

import com.google.gwt.user.client.rpc.AsyncCallback;
import com.gwtplatform.dispatch.shared.DispatchRequest;

/**
 * The interface that {@link com.gwtplatform.dispatch.client.interceptor.Interceptor Interceptor}s use to send the
 * action to execute to the server.
 *
 * @param  The action type.
 * @param  The result type.
 */
public interface ExecuteCommand {
    /**
     * Execute an action.
     *
     * @param action The action to execute.
     * @param resultCallback A callback that will be invoked once the action has been executed, successfully or not.
     *
     * @return A {@link DispatchRequest} representing the request, it should never be {@code null}.
     */
    DispatchRequest execute(A action, AsyncCallback resultCallback);
}