org.bonitasoft.engine.operation.Operation 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;

import org.bonitasoft.engine.bpm.process.Visitable;
import org.bonitasoft.engine.expression.Expression;

/**
 * An Operation has a LeftOperand (typically, for assignment operations, left operand is the
 * part of the operation receiving the
 * value), an OperatorType which defines the type of operation to execute
 * and a right operand, represented by an Expression.
 *
 * @see LeftOperand
 * @see Expression
 * @see OperatorType
 * @author Zhang Bole
 * @author Emmanuel Duchastenier
 */
public interface Operation extends Serializable, Visitable, Cloneable {

    /**
     * @return the LeftOperand of this Operation, representing what entity will be set after
     *         execution.
     */
    LeftOperand getLeftOperand();

    /**
     * @deprecated As of 6.0 replaced by {@link #getLeftOperand()}
     */
    @Deprecated
    LeftOperand getVariableToSet();

    /**
     * @return the operator type of this Operation.
     */
    OperatorType getType();

    /**
     * @return the operator of this Operation,as a String.
     */
    String getOperator();

    /**
     * @return the right operand Expression to be evaluated before executing the operation
     */
    Expression getRightOperand();

    Operation copy();

}