org.eurekaclinical.standardapis.dao.Dao Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eurekaclinical-standard-apis Show documentation

A library of classes shared across the Eureka! Clinical platform.

There is a newer version: 4.1-Alpha-1

Show newest version

package org.eurekaclinical.standardapis.dao;

/*-
 * #%L
 * Eureka! Clinical Standard APIs
 * %%
 * Copyright (C) 2016 Emory University
 * %%
 * 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.util.List;

/**
 * Provides an interface for the common CRUD operations for an entity.
 *
 * @param  The type of the entity.
 * @param  The type of the primary key of the entity.
 * @author hrathod
 */
public interface Dao {

    /**
     * Creates (persists) the given entity in the data store.
     *
     * @param entity The entity to create (persist).
     * @return The persisted entity. Useful for chained method calls, if needed.
     */
    T create(T entity);

    /**
     * Retrieves the entity referred to by the unique identifier from the data
     * store.
     *
     * @param uniqueId The unique identifier for the entity to retrieve.
     * @return The retrieved entity, or null if it can not be found.
     */
    T retrieve(PK uniqueId);

    /**
     * Updates the data store using the given entity.
     *
     * @param entity The entity to use for updates to the data store.
     * @return The given entity. Useful for chained method calls, if needed.
     */
    T update(T entity);

    /**
     * Removes the given entity from the data store.
     *
     * @param entity The entity to remove from the data store.
     * @return The removed entity.
     */
    T remove(T entity);

    /**
     * Refreshes the given entity instance with latest information from the data
     * store.
     *
     * @param entity The entity to refresh from the data store.
     * @return The refreshed entity.
     */
    T refresh(T entity);

    /**
     * Retrieves a list of all the entities of the given type in the data store.
     *
     * @return A list of all entities in the data store.
     */
    List getAll();
    
}