org.bonitasoft.engine.bpm.data.DataInstance 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 java.io.Serializable;

import org.bonitasoft.engine.bpm.BaseElement;
import org.bonitasoft.engine.bpm.NamedElement;

/**
 * This object represents this instance of {@link DataDefinition} generated when the associated
 * {@link org.bonitasoft.engine.bpm.process.ProcessInstance} or
 * {@link org.bonitasoft.engine.bpm.flownode.FlowNodeInstance} is instantiated.
 *
 * @author Feng Hui
 * @author Celine Souchet
 * @since 6.0.0
 * @version 6.4.1
 */
public interface DataInstance extends NamedElement, BaseElement {

    /**
     * Get the description of the data defined in {@link DataDefinition}.
     *
     * @return The description of the data.
     * @since 6.0.0
     * @see DataDefinition#getDescription()
     */
    String getDescription();

    /**
     * Get the class name of the type of the data defined in {@link DataDefinition}.
     *
     * @return The class name of the type of the data.
     * @since 6.0.0
     * @see DataDefinition#getClassName()
     */
    String getClassName();

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

    /**
     * Get the value of the data.
     *
     * @return The value of the data.
     * @since 6.0.0
     */
    Serializable getValue();

    /**
     * Get the identifier of the element where the data is defined. The element can be a
     * {@link org.bonitasoft.engine.bpm.process.ProcessInstance} or a
     * {@link org.bonitasoft.engine.bpm.flownode.FlowNodeInstance}.
     *
     * @return The identifier of the container of the data.
     * @since 6.0.0
     * @see org.bonitasoft.engine.bpm.process.ProcessInstance#getId()
     * @see org.bonitasoft.engine.bpm.flownode.FlowNodeInstance#getId()
     */
    long getContainerId();

    /**
     * Get the type of the element where the data is defined.
     * The list of value for this field is :
     * 
     * 
     * PROCESS_INSTANCE
     * 
     * 
     * ACTIVITY_INSTANCE
     * 
     * 
     * MESSAGE_INSTANCE
     * 
     * 
     *
     * @return The type of the container of the data.
     * @since 6.0.0
     */
    String getContainerType();

}