org.bonitasoft.engine.bpm.data.DataDefinition 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.bpm.data;

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

/**
 * It forms part of the {@link org.bonitasoft.engine.bpm.process.ProcessDefinition}. It is used to define a date in the
 * context of a
 * {@link org.bonitasoft.engine.bpm.process.ProcessDefinition} or a
 * {@link org.bonitasoft.engine.bpm.flownode.FlowNodeDefinition}.
 *
 * @author Matthieu Chaffotte
 * @author Feng Hui
 * @author Celine Souchet
 * @since 6.0.0
 * @version 6.4.1
 */
public interface DataDefinition extends DescriptionElement, Visitable {

    /**
     * Get the class name of the type of the data.
     *
     * @return The class name of the type of the data.
     * @since 6.0.0
     */
    String getClassName();

    /**
     * Is it transient?
     *
     * @return true if the data is transient, false otherwise.
     * @since 6.0.0
     */
    boolean isTransientData();

    /**
     * Get the expression representing the default value of the data.
     *
     * @return The default value of the data.
     * @since 6.0.0
     */
    Expression getDefaultValueExpression();

}