org.nuiton.topia.persistence.TopiaPersistenceContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
ToPIA API module
The newest version!
package org.nuiton.topia.persistence;

/*
 * #%L
 * ToPIA Extension :: API
 * %%
 * Copyright (C) 2018 - 2022 Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import io.ultreia.java4all.util.sql.SqlScript;
import io.ultreia.java4all.util.sql.SqlScriptConsumer;
import io.ultreia.java4all.util.sql.SqlScriptReader;
import org.nuiton.topia.persistence.support.TopiaSqlSupport;

import java.io.Closeable;

/**
 * This contract represents a persistence context, which lifecycle is linked to the transaction lifecycle.
 *
 * It extends contracts such as :
 * 
 * {@link org.nuiton.topia.persistence.TopiaTransaction} - to deal with transaction lifecycle
 * {@link org.nuiton.topia.persistence.TopiaDaoSupplier} - to let user get any Dao instance
 * 
 *
 * In addition to these contracts, there is some other methods :
 * 
 * Generic entity find
 * DAO factory
 * Schema management
 * 
 *
 * @author Arnaud Thimel (Code Lutin)
 * @since 3.0
 */
public interface TopiaPersistenceContext extends TopiaDaoSupplier, TopiaTransaction, Closeable {

    /**
     * Retrieve {@link org.nuiton.topia.persistence.TopiaEntity} using its unique {@code topiaId}.
     *
     * @param topiaId unique identifier of the entity in all the application.
     * @param      type of entity
     * @return the entity found or null
     */
     E findByTopiaId(String topiaId);

    /**
     * Add into this TopiaContext an entity created by another TopiaContext
     *
     * @param entity the entity to add
     */
    void update(TopiaEntity entity);

    /**
     * Delete into this TopiaContext an entity created by another TopiaContext
     *
     * @param entity the entity to delete
     */
    void delete(TopiaEntity entity);

    /**
     * Delete into this TopiaContext an entities created by another TopiaContext
     *
     * @param entities the entities to delete
     * @param       type of entity
     */
     void deleteAll(Iterable entities);

    /**
     * Get the currently configured {@link TopiaIdFactory}.
     *
     * @return the {@link TopiaIdFactory} in use
     * @see org.nuiton.topia.persistence.TopiaIdFactory
     * @since 3.0
     */
    TopiaIdFactory getTopiaIdFactory();

    TopiaSqlSupport getSqlSupport();

    /**
     * Tells if the context is closed
     *
     * @return {@code true} if the context is closed, {@code false} otherwise
     */
    boolean isClosed();

    /**
     * Closes the PersistenceContext.
     * 
     * After calling close, it's impossible to make any operation on the database.
     */
    @Override
    void close();


    void executeSqlScript(SqlScript content);

    void executeSqlScript(SqlScriptReader content);

    void executeSqlScript(SqlScriptConsumer content);


}