org.fryske_akademy.ejb.CrudWriteService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ejbCrudApi Show documentation
The newest version!
/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */
package org.fryske_akademy.ejb;

/*-
 * #%L
 * ejbCrudApi
 * %%
 * Copyright (C) 2018 Fryske Akademy
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
import java.io.Serializable;
import java.util.Collection;
import java.util.stream.Stream;
import javax.transaction.Transactional;
import org.fryske_akademy.Util;
import org.fryske_akademy.jpa.EntityInterface;

/**
 * Generic interface for write operations on entities
 *
 * @author eduard
 */
public interface CrudWriteService extends Serializable {

    public  T create(T t);

    public  T update(T t);

    /**
     * create or update depending on {@link EntityInterface#isTransient() }.
     *
     * @param 
     * @param t
     * @return
     */
    public  T save(T t);

    public void delete(EntityInterface t);

    /**
     * save multiple entities, NOTE that normally only after commit or flush
     * entitymanagers will reflect changes caused by saving all entities, this
     * may cause entitylisteners to fail. You may need to perform checks on the
     * collection before calling this method. Also note that entitylisteners
     * will execute within the batch transaction, you may need to specify
     * {@link Transactional.TxType} on the bean that you use in your listeners,
     * use isolation level 0 (not recommended) or use XA when you need to access
     * resources from your listeners. When flushCount != null flushes and clears
     * the entitymanager every flushCount entities. NOTE that this method
     * executes in one (possibly big) sql transaction! You can use
     * {@link EntityException} in for example your listeners to find out in case
     * of failure which enitity caused it.
     *
     * @see Util#getBean(java.lang.Class,
     * javax.enterprise.inject.spi.BeanManager,
     * java.lang.annotation.Annotation...)
     *
     * @param entities
     * @param flushCount when not null try to optimize (flush/clear) every so
     * many entities
     * @return the saved entities
     */
    public  Stream batchSave(Collection entities, Integer flushCount);

    /**
     * save multiple entities, NOTE that normally only after commit or flush
     * entitymanagers will reflect changes caused by saving all entities, this
     * may cause entitylisteners to fail. You may need to perform checks on the
     * collection before calling this method. Also note that entitylisteners
     * will execute within the batch transaction, you may need to specify
     * {@link Transactional.TxType} on the bean that you use in your listeners,
     * use isolation level 0 (not recommended) or use XA when you need to access
     * resources from your listeners. When flushCount != null flushes and clears
     * the entitymanager every flushCount entities. NOTE that this method
     * executes in one (possibly big) sql transaction! You can use
     * {@link EntityException} in for example your listeners to find out in case
     * of failure which enitity caused it.
     *
     * @see Util#getBean(java.lang.Class,
     * javax.enterprise.inject.spi.BeanManager,
     * java.lang.annotation.Annotation...)
     *
     * @param entities
     * @param flushCount when not null try to optimize (flush/clear) every so
     * many entities
     * @return number of entities deleted
     */
    public int batchDelete(Collection entities, Integer flushCount);

}