source: ether_ndacc_bis/persistence/interface/com/ether/dao/DomainAccessObject.java @ 827

package com.ether.dao;

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

import org.hibernate.SessionFactory;
import org.hibernate.criterion.DetachedCriteria;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import com.ether.PersistenceException;

public interface DomainAccessObject<DO, PK extends Serializable>
{
    /**
     * @return the domain object class.
     */
    Class<DO> getDomainObjectClass();

    /**
     * Selects an object by criteria.
     * The result of the select can be an object or any other types in case of projection or a transformed result.
     *
     * @param criteria the criteria.
     * @return the first persistent object that match the criteria.
     */
    @Nullable
    DO selectByCriteria( DetachedCriteria criteria )
            throws PersistenceException;

    /**
     * Selects an object by criteria.
     * The result of the select can be an object or any other types in case of projection or a transformed result.
     *
     * @param objectClass the object class.
     * @param criteria    the criteria.
     * @return the first persistent object that match the criteria.
     */
    @Nullable
    <O> O selectByCriteria( Class<O> objectClass, DetachedCriteria criteria )
            throws PersistenceException;
    
    /**
     * Selects by criteria. The criteria must created for the object class.
     * The result of the select can contain an object list or any other types in case of projection or a transformed result.
     *
     * @param criteria the criterions.
     * @return all persistent objects that match the criteria.
     */
    @NotNull
    List<DO> selectAllByCriteria( DetachedCriteria criteria )
            throws PersistenceException;

    /**
     * Selects by criteria. The criteria must created for the object class.
     * The result of the select can contain an object list or any other types in case of projection or a transformed result.
     *
     * @param objectClass the object class.
     * @param criteria    the criterions.
     * @return all persistent objects that match the criteria.
     */
    @NotNull
    <O> List<O> selectAllByCriteria( Class<O> objectClass, DetachedCriteria criteria )
            throws PersistenceException;
    
    /**
     * Retrieves a domain object that was previously persisted to the database using
     * the specified primary key.
     *
     * @param primaryKey the primary key.
     * @return the persistent object with the specified primary key. <code>null</code> if not found
     */
    @Nullable
    DO selectByPrimaryKey( @NotNull final PK primaryKey )
            throws PersistenceException;

    /**
     * Retrieves a domain object by example.
     *
     * @param domainObject the example domain object.
     * @return a domain object by example.
     */
    DO selectByExample( final DO domainObject )
            throws PersistenceException;

    /**
     * Retrieves a domain object by example.
     *
     * @param domainObject the example domain object.
     * @return a domain object by example.
     */
    List<DO> selectAllByExample( final DO domainObject )
            throws PersistenceException;
    
    /**
     * Returns all persistent objects of type.
     *
     * @return all persistent objects of type.
     * @throws PersistenceException the persistence exception.
     */
    List<DO> selectAll()
            throws PersistenceException;
    
    /**
     * Persists a domain object into database and return the object primary key.
     *
     * @param domainObject a domain object.
     * @return the primary key.
     */
    @NotNull
    PK insert( final DO domainObject )
            throws PersistenceException;

    void insertAll( @NotNull final Collection<DO> domainObjects )
            throws PersistenceException;

    /**
     * Updates persistent object with domain object changes.
     *
     * @param domainObject a domain object.
     */
    void update( final DO domainObject )
            throws PersistenceException;

    /**
     * Updates persistent objects with domain objects changes.
     *
     * @param domainObjects domain objects to update.
     */
    void updateAll( final Collection<? extends DO> domainObjects )
            throws PersistenceException;

    /**
     * Upgrades domain object with persistent objects changes.
     *
     * @param domainObject the domain object.
     */
    void upgrade( final DO domainObject )
            throws PersistenceException;

    /**
     * Upgrades domain objects with persistent objects changes.
     *
     * @param domainObjects the domain object.
     */
    void upgradeAll( final Collection<DO> domainObjects )
            throws PersistenceException;

    /**
     * Deletes the primary key.
     *
     * @param primaryKey the primary key.
     */
    void deleteByPrimaryKey( final PK primaryKey )
            throws PersistenceException;

    /**
     * Deletes an object from persistent storage in the database.
     *
     * @param domainObject the domain object.
     */
    void delete( final DO domainObject )
            throws PersistenceException;

    /**
     * Deletes all domain objects in the database.
     *
     * @param domainObjects the domain objects to delete.
     */
    void deleteAll( final Collection<DO> domainObjects )
            throws PersistenceException;

     /**
     * Sets the session factory.
     * @param sessionFactory the session factory.
     */
    void setSessionFactory( SessionFactory sessionFactory );
}