org.bonitasoft.engine.bpm.process.DesignProcessDefinition 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.process;

import java.util.List;
import java.util.Set;

import org.bonitasoft.engine.bpm.actor.ActorDefinition;
import org.bonitasoft.engine.bpm.context.ContextEntry;
import org.bonitasoft.engine.bpm.contract.ContractDefinition;
import org.bonitasoft.engine.bpm.flownode.impl.FlowElementContainerDefinition;
import org.bonitasoft.engine.bpm.parameter.ParameterDefinition;
import org.bonitasoft.engine.expression.Expression;

/**
 * Represents the Design Definition of a process. It gives access to process attributes.
 * 
 * display name
 * description
 * parameters
 * actors
 * search keys
 * 
 *
 * @author Matthieu Chaffotte
 * @author Celine Souchet
 * @author Laurent Leseigneur
 * @version 6.3.5
 * @since 6.0.0
 */
public interface DesignProcessDefinition extends ProcessDefinition {

    /**
     * Retrieves the displayed name of the process definition, as set at design-time.
     *
     * @return The displayed name of the process definition, as set at design-time.
     */
    String getDisplayName();

    /**
     * Retrieves the displayed description of the process definition, as set at design-time.
     *
     * @return The displayed description of the process definition, as set at design-time.
     */
    String getDisplayDescription();

    /**
     * Retrieves the definition of the FlowElementContainerDefinition of the process container.
     * 
     * This method is deprecated. Please, use {@link #getFlowElementContainer()} instead.
     * 
     * Th
     *
     * @return The {@link FlowElementContainerDefinition} of the process container.

     *         return type FlowElementContainerDefinition in this package is deprecated. Instead use
     *         {@link org.bonitasoft.engine.bpm.flownode.FlowElementContainerDefinition}
     */
    @Deprecated
    FlowElementContainerDefinition getProcessContainer();

    /**
     * Returns a {@link org.bonitasoft.engine.bpm.flownode.FlowElementContainerDefinition} containing all flow elements
     * of this process.
     *
     * @return a {@code FlowElementContainerDefinition} containing all flow elements of this process.
     * @see org.bonitasoft.engine.bpm.flownode.FlowElementContainerDefinition
     * @since 6.4.1
     */
    org.bonitasoft.engine.bpm.flownode.FlowElementContainerDefinition getFlowElementContainer();

    /**
     * Retrieves a Set of ParameterDefinition objects from a ProcessDefinition
     *
     * @return A set of {@link ParameterDefinition} objects
     */
    Set getParameters();

    /**
     * Retrieves a Set of ActorDefinition objects from a ProcessDefinition
     *
     * @return A set of {@link ActorDefinition} objects.
     *         
If no actors have been defined, return an empty Set.
     * @see #getActorsList()
     * @since 6.0
     * @deprecated As of release 6.1, replaced by {@link #getActorsList()} which return the same information as a list
     */
    @Deprecated
    Set getActors();

    /**
     * Gets the list of all actors defined on this process.
     *
     * @return The list of {@link ActorDefinition} objects defined in this process.
     *         
If no actors have been defined, return an empty List.
     * @since 6.1
     */
    List getActorsList();

    /**
     * Retrieves the ActorDefinition of process's actor defined as initiator.
     *
     * @return The {@link ActorDefinition} of process's actor defined as initiator.
     * @since 6.1
     */
    ActorDefinition getActorInitiator();

    /**
     * Retrieves the label for the ProcessDefinition given search key, also known as string index.
     * 
     * You can define up to five search keys for a process. See more at Define a search
     * key Bonitasoft documentation page
     * 
     *
     * @param index
     *        The position of search key to retrieve. Valid values are between 1 and 5 (inclusive)
     * @throws IndexOutOfBoundsException if index is invalid
     * @return The label of the search key
     */
    String getStringIndexLabel(int index);

    /**
     * Retrieves the label list for the ProcessDefinition given search key, also known as string index.
     * 
     * You can define up to five search keys for a process. See more at Define a search
     * key Bonitasoft documentation page
     * 
     *
     * @throws IndexOutOfBoundsException if index is invalid
     * @return The label list of the search keys
     */

    List getStringIndexLabels();

    /**
     * Retrieves the Expression for the ProcessDefinition given search key, also known as string index.
     * 
     * You can define up to five search keys for a process. See more at Define a search
     * key Bonitasoft documentation page
     * 
     *
     * @param index
     *        The position of search key to retrieve. Valid values are between 1 and 5 (inclusive)
     * @throws IndexOutOfBoundsException if index is invalid
     * @return The {@link Expression} of the search key
     */
    Expression getStringIndexValue(int index);

    /**
     * Retrieves the Expression list of the ProcessDefinition search key values, also known as string index.
     * 
     * You can define up to five search keys for a process. See more at Define a search
     * key Bonitasoft documentation page
     * 
     *
     * @return The {@link Expression} list of the search keys
     */
    List getStringIndexValues();

    /**
     * Contract that must be respected when starting an instance of this process
     *
     * @return
     *         the process instantiation contract
     */
    ContractDefinition getContract();

    List getContext();

}