org.bonitasoft.engine.operation.LeftOperand Maven / Gradle / Ivy

Go to download

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

Bonita Common is the useful layer common to bonita-client and bonita-server

There is a newer version: 10.2.0

/**
 * Copyright (C) 2019 Bonitasoft S.A.
 * Bonitasoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation
 * version 2.1 of the License.
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301, USA.
 **/
package org.bonitasoft.engine.operation;

import java.io.Serializable;

/**
 * @author Zhang Bole
 * @author Matthieu Chaffotte
 * @author Emmanuel Duchastenier
 * @author Baptiste Mesta
 */
public interface LeftOperand extends Serializable {

    String TYPE_DATA = "DATA";

    String TYPE_BUSINESS_DATA = "BUSINESS_DATA";

    String TYPE_SEARCH_INDEX = "SEARCH_INDEX";

    String TYPE_DOCUMENT = "DOCUMENT";

    String TYPE_DOCUMENT_LIST = "DOCUMENT_LIST";

    String TYPE_EXTERNAL_DATA = "EXTERNAL_DATA";

    String TYPE_TRANSIENT_DATA = "TRANSIENT_DATA";

    String getName();

    /**
     * @deprecated As of 6.0 replaced by {@link #getName()}
     */
    @Deprecated
    String getDataName();

    /**
     * The type of the left operand
     * It define what kind of resource the operation will update
     *
     * @return
     *         the type of the left operand
     */
    String getType();

    /**
     * @deprecated As of 6.3.0 replaced by {@link #getType()}
     */
    @Deprecated
    boolean isExternal();

}