/*******************************************************************************
* Australian National University Data Commons
* Copyright (C) 2013 The Australian National University
*
* This file is part of Australian National University Data Commons.
*
* Australian National University Data Commons 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 <http://www.gnu.org/licenses/>.
******************************************************************************/
package au.edu.anu.datacommons.xslt.db.dao;
import java.io.Serializable;
import java.util.List;
/**
* GenericDAO
*
* Australian National University Data Commons
*
* Generic Data Access Object implementation
*
* JUnit Coverage:
* None
*
* <pre>
* Version Date Developer Description
* 0.1 18/02/2013 Genevieve Turner (GT) Initial
* </pre>
*
*/
public interface GenericDAO <T, PK extends Serializable>{
/**
* create
*
* Creates the object in the database
*
* <pre>
* Version Date Developer Description
* 0.1 18/02/2013 Genevieve Turner (GT) Initial
* </pre>
*
* @param t The object to create in the database
* @return
*/
T create(T t);
/**
* getSingleById
*
* Retrieves the object by the primary key
*
* <pre>
* Version Date Developer Description
* 0.1 18/02/2013 Genevieve Turner (GT) Initial
* </pre>
*
* @param id The primary key of the object to retrieve
* @return
*/
T getSingleById(PK id);
/**
* getAll
*
* Retrieves all objects of the approriate type
*
* <pre>
* Version Date Developer Description
* 0.1 18/02/2013 Genevieve Turner (GT) Initial
* </pre>
*
* @return A list of objects of the appropriate type
*/
List<T> getAll();
/**
* update
*
* Updates the object in the database
*
* <pre>
* Version Date Developer Description
* 0.1 18/02/2013 Genevieve Turner (GT) Initial
* </pre>
*
* @param t The object to update
* @return
*/
T update(T t);
/**
* delete
*
* Removes objects from the database
*
* <pre>
* Version Date Developer Description
* 0.1 18/02/2013 Genevieve Turner (GT) Initial
* </pre>
*
* @param t The object to delete
*/
void delete(PK id);
}