org.bonitasoft.engine.persistence.ReadPersistenceService 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.persistence;

import java.util.List;
import java.util.Map;

import org.bonitasoft.engine.commons.exceptions.SRetryableException;

/**
 * @author Charles Souillard
 * @author Matthieu Chaffotte
 */
public interface ReadPersistenceService {

    /**
     * @param selectDescriptor
     * @return
     * @throws SBonitaReadException
     * @throws SRetryableException
     */
     T selectById(SelectByIdDescriptor selectDescriptor) throws SBonitaReadException;

    /**
     * @param selectDescriptor
     * @return
     * @throws SBonitaReadException
     * @throws SRetryableException
     */
     T selectOne(SelectOneDescriptor selectDescriptor) throws SBonitaReadException;

    /**
     * @param selectDescriptor
     * @return
     * @throws SBonitaReadException
     * @throws SRetryableException
     */
     List selectList(SelectListDescriptor selectDescriptor) throws SBonitaReadException;

    /**
     * @param entityClass
     * @param options
     * @param parameters
     * @return
     * @throws SBonitaReadException
     * @throws SRetryableException
     */
     long getNumberOfEntities(Class entityClass, QueryOptions options,
            Map parameters)
            throws SBonitaReadException;

    /**
     * @param entityClass
     * @param querySuffix
     * @param options
     * @param parameters
     * @return
     * @throws SBonitaReadException
     * @throws SRetryableException
     */
     long getNumberOfEntities(Class entityClass, String querySuffix,
            QueryOptions options, Map parameters)
            throws SBonitaReadException;

    /**
     * @param entityClass
     * @param options
     * @param parameters
     * @return
     * @throws SBonitaReadException
     * @throws SRetryableException
     */
     List searchEntity(Class entityClass, QueryOptions options,
            Map parameters)
            throws SBonitaReadException;

    /**
     * @param entityClass
     *        class of the object we want to search on
     * @param querySuffix
     *        Used to define customized search query
     * @param options
     *        query options
     * @param parameters
     * @return
     * @throws SBonitaReadException
     * @throws SRetryableException
     */
     List searchEntity(Class entityClass, String querySuffix, QueryOptions options,
            Map parameters)
            throws SBonitaReadException;

}