org.bonitasoft.engine.business.data.BusinessDataRepository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bonita-server Show documentation
The newest version!
/**
 * 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.business.data;

import java.io.Serializable;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.bonitasoft.engine.bdm.Entity;
import org.bonitasoft.engine.commons.TenantLifecycleService;

/**
 * The BusinessDataRepository service allows to manage Business Data operations. It includes deploy / undeploy of a
 * Business Data Model, search / find / create
 * / update of Business Data entity objects.
 *
 * @author Matthieu Chaffotte
 * @author Emmanuel Duchastenier
 * @see Entity
 */
public interface BusinessDataRepository extends TenantLifecycleService {

    /**
     * Finds an Entity that is defined in a deployed Business Data Model.
     *
     * @param entityClass the class of the entity to search for.
     * @param primaryKey the primary key to search by.
     * @return the found entity, if any.
     * @throws SBusinessDataNotFoundException if the Business Data could not be found with the provided primary key.
     */
     T findById(Class entityClass, Long primaryKey) throws SBusinessDataNotFoundException;

    /**
     * Finds entities that is defined in a deployed Business Data Model. If a primary key does not match an existing
     * entity no exception is thrown and nothing
     * is added in the list.
     *
     * @param entityClass the class of the entity to search for.
     * @param primaryKeys the primary keys.
     * @return the list of found entities
     */
     List findByIds(Class entityClass, List primaryKeys);

    /**
     * Finds (well-loaded) entities that is defined in a deployed Business Data Model. If a primary key does not match
     * an existing entity no exception is thrown
     * and nothing is added in the list.
     *
     * @param entityClass the class of the entity to search for.
     * @param primaryKeys the primary keys.
     * @return the list of found entities
     */
     List findByIdentifiers(Class entityClass, List primaryKeys);

    /**
     * Finds an Entity that is defined in a deployed Business Data Model, through JPQL query.
     *
     * @param resultClass the class of the entity to search for.
     * @param jpqlQuery the JPQL query string to search the entity.
     * @param parameters the parameters needed to execute the query.
     * @return the found entity, if any.
     * @throws SBusinessDataNotFoundException if the Business Data could not be found with the provided primary key.
     * @throws NonUniqueResultException if more than one result was found.
     */
     T find(Class resultClass, String jpqlQuery, Map parameters)
            throws NonUniqueResultException;

     List findList(Class resultClass, String jpqlQuery,
            Map parameters, int startIndex, int maxResults);

     T findByNamedQuery(String queryName, Class resultClass,
            Map parameters) throws NonUniqueResultException;

     List findListByNamedQuery(String queryName, Class resultClass,
            Map parameters, int startIndex,
            int maxResults);

    /**
     * Saves or updates an entity in the Business Data Repository.
     *
     * @param entity the entity to save / update.
     * @return the freshly persisted entity.
     */
    void persist(Entity entity);

    /**
     * Removes an entity from the Business Data Repository.
     *
     * @param entity the entity to remove.
     */
    void remove(Entity entity);

    /**
     * Reconnect the given entity with the persistence unit
     *
     * @param entity the entity to reconnect.
     * @return the connected entity.
     */
    Entity merge(Entity entity);

    /**
     * Retrieves the Set of known Entity class names in this Business Data Repository.
     *
     * @return the Set of known Entity class names, as qualified class names.
     */
    Set getEntityClassNames();

    /**
     * Unwraps the Entity if necessary.
     *
     * @param wrapped the potential wrapped entity
     * @return the unwrapped entity
     */
    Entity unwrap(final Entity wrapped);

}