com.cedarsoft.gdao.GenericDao Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of genericdao Show documentation
The newest version!
package com.cedarsoft.gdao;

import com.cedarsoft.CommitableObjectAccess;
import org.jetbrains.annotations.NotNull;
import org.springframework.dao.DataAccessException;
import org.springframework.dao.EmptyResultDataAccessException;

import java.util.List;

/**
 * A generic dao. This implementation expects a Long as PK
 *
 * @param  the type this dao can manage
 */
public interface GenericDao extends CommitableObjectAccess {
  /**
   * Saves the newInstance object into database
   */
  @NotNull
           Long save( @NotNull LT newInstance ) throws DataAccessException;

  /**
   * Save changes made to a persistent object.
   */
   void update( @NotNull LT transientObject ) throws DataAccessException;

  /**
   * Stores the changes to a persistent object or saves it
   *
   * @param object the object
   */
   void saveOrUpdate( @NotNull LT object ) throws DataAccessException;

  /**
   * Remove an object from persistent storage in the database
   */
   void delete( @NotNull LT persistentObject ) throws DataAccessException;

  /**
   * Retrieve an object that was previously persisted to the database using
   * the indicated id as primary key
   *
   * @param id the id of the bean that is loaded
   */
  @NotNull
  T findById( @NotNull Long id ) throws EmptyResultDataAccessException;

  /**
   * Finds an object.
   *
   * @param finder the selector
   * @return the selected objects
   *
   * @throws EmptyResultDataAccessException if nothing has been found
   */
  @NotNull
           R find( @NotNull Finder finder ) throws EmptyResultDataAccessException;

  /**
   * Selects all objects
   *
   * @return all objects
   */
  @NotNull
  List findAll() throws DataAccessException;

  /**
   * Returns the count
   *
   * @return the count
   */
  int getCount() throws DataAccessException;

  /**
   * Shuts the dao down
   */
  void shutdown();
}