vaadin-framework/shared/src/main/java/com/vaadin/shared/ui/grid/editor/EditorServerRpc.java

/*
 * Copyright 2000-2021 Vaadin Ltd.
 *
 * 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.vaadin.shared.ui.grid.editor;

import com.vaadin.shared.communication.ServerRpc;

/**
 * An RPC interface for the grid editor client-to-server communications.
 *
 * @since 8.0
 * @author Vaadin Ltd
 */
public interface EditorServerRpc extends ServerRpc {

    /**
     * Asks the server to open the editor and bind data to it. When a bind
     * request is sent, it must be acknowledged with a
     * {@link EditorClientRpc#confirmBind(boolean) confirm call} before the
     * client can open the editor.
     *
     * @param key
     *            the identifier key for edited item
     */
    void bind(String key);

    /**
     * Asks the server to save unsaved changes in the editor to the bean. When a
     * save request is sent, it must be acknowledged with a
     * {@link EditorClientRpc#confirmSave(boolean) confirm call}.
     */
    void save();

    /**
     * Tells the server to cancel editing. When sending a cancel request, the
     * client does not need to wait for confirmation by the server before hiding
     * the editor.
     *
     * @param afterBeingSaved
     *            if {@code true} then this method is called to close editor
     *            after save action, otherwise it represents a cancel action
     */
    void cancel(boolean afterBeingSaved);

    /**
     * Asks the server to check the validity of the current values in the
     * editor. When a check-validity request is sent, the server must respond
     * with a {@link EditorClientRpc#confirmValidity(boolean) confirm call}.
     */
    void checkValidity();
}