org.appfuse.dao.GenericDao Maven / Gradle / Ivy
package org.appfuse.dao;
import java.io.Serializable;
import java.util.List;
/**
* Generic DAO (Data Access Object) with common methods to CRUD POJOs.
*
* Extend this interface if you want typesafe (no casting necessary) DAO's for your
* domain objects.
*
* @author Bryan Noll
* @param a type variable
* @param the primary key for that type
*/
public interface GenericDao {
/**
* Generic method used to get all objects of a particular type. This
* is the same as lookup up all rows in a table.
* @return List of populated objects
*/
List getAll();
/**
* Gets all records without duplicates.
* Note that if you use this method, it is imperative that your model
* classes correctly implement the hashcode/equals methods
* @return List of populated objects
*/
List getAllDistinct();
/**
* Generic method to get an object based on class and identifier. An
* ObjectRetrievalFailureException Runtime Exception is thrown if
* nothing is found.
*
* @param id the identifier (primary key) of the object to get
* @return a populated object
* @see org.springframework.orm.ObjectRetrievalFailureException
*/
T get(PK id);
/**
* Checks for existence of an object of type T using the id arg.
* @param id the id of the entity
* @return - true if it exists, false if it doesn't
*/
boolean exists(PK id);
/**
* Generic method to save an object - handles both update and insert.
* @param object the object to save
* @return the persisted object
*/
T save(T object);
/**
* Generic method to delete an object based on class and id
* @param id the identifier (primary key) of the object to remove
*/
void remove(PK id);
}