com.eclecticlogic.pedal.dm.DAO Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of pedal Show documentation

Pedal is an idiomatic JPA and Spring based DAO framework.

There is a newer version: 1.4.18

/**
 * Copyright (c) 2014 Eclectic Logic LLC
 * 
 * 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.
 * 
 */
package com.eclecticlogic.pedal.dm;

import java.io.Serializable;
import java.util.List;
import java.util.Optional;

import javax.persistence.LockModeType;

/**
 * @author kabram.
 *
 * @param  The Entity type.
 * @param  The type of the primary key.
 */
public interface DAO extends DAOMeta {

    /**
     * @param entity Entity to create (persist) in the database.
     * @return
     */
    public E create(E entity);


    /**
     * @param entities Collection of entries to create.
     * @return List of the entries that were created.
     */
    @SuppressWarnings("unchecked")
    public List create(E... entities);


    public Optional findById(P id);


    @SuppressWarnings("unchecked")
    public List findById(P... ids);


    public List findAll();


    public E update(E entity);


    @SuppressWarnings("unchecked")
    public List update(E... entities);


    public E delete(E entity);


    @SuppressWarnings("unchecked")
    public List delete(E... entities);


    /**
     * @param entity Entity to lock
     * @param lockMode Locking mode
     * @return Locked entity refreshed to reflect state after locking.
     */
    public E lock(E entity, LockModeType lockMode);
    
    
    /**
     * @param id Primary key of row to be locked.
     * @param lockMode Locking mode
     * @return Locked entity.
     */
    public E lockById(P id, LockModeType lockMode);

}