GeneralDAO (Hibernate Generic DAO

All Known Implementing Classes:

DAODispatcher, GeneralDAOImpl
```
public interface GeneralDAO
```
Interface for general Data Access Object that can be used for any type domain object. A single instance implementing this interface can be used for multiple types of domain objects.

Author:

dwolverton

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`count(ISearch search)` Returns the total number of results that would be returned using the given `ISearch` if there were no paging or maxResults limits.
`<T> T[]`	`find(Class<T> type, Serializable... ids)` Get all entities of the specified type from the datastore that have one of these ids.
`<T> T`	`find(Class<T> type, Serializable id)` Get the entity with the specified type and id from the datastore.
`<T> List<T>`	`findAll(Class<T> type)` Get a list of all the objects of the specified type.
`void`	`flush()` Flushes changes in the Hibernate session to the datastore.
`Filter`	`getFilterFromExample(Object example)` Generates a search filter from the given example using default options.
`Filter`	`getFilterFromExample(Object example, ExampleOptions options)` Generates a search filter from the given example using the specified options.
`<T> T`	`getReference(Class<T> type, Serializable id)` Get a reference to the entity with the specified type and id from the datastore.
`<T> T[]`	`getReferences(Class<T> type, Serializable... ids)` Get a reference to the entities of the specified type with the given ids from the datastore.
`boolean`	`isAttached(Object entity)` Returns `true` if the object is connected to the current Hibernate session.
`Object[]`	`merge(Object... entities)` Copy the state of the given objects onto the persistent objects with the same identifier.
`<T> T`	`merge(T entity)` Copy the state of the given object onto the persistent object with the same identifier.
`void`	`persist(Object... entities)` Make a transient instance persistent and add it to the datastore.
`void`	`refresh(Object... entities)` Refresh the content of the given entity from the current datastore state.
`void`	`remove(Object... entities)` Remove all of the specified entities from the datastore.
`boolean`	`remove(Object entity)` Remove the specified entity from the datastore.
`boolean`	`removeById(Class<?> type, Serializable id)` Remove the entity with the specified type and id from the datastore.
`void`	`removeByIds(Class<?> type, Serializable... ids)` Remove all the entities of the given type from the datastore that have one of these ids.
`Object[]`	`save(Object... entities)` For each entity: If an entity with the same ID already exists in the database, merge the changes into that entity.
`<T> T`	`save(T entity)` If an entity with the same ID already exists in the database, merge the changes into that entity.
`List`	`search(ISearch search)` Search for objects given the search parameters in the specified `ISearch` object.
`SearchResult`	`searchAndCount(ISearch search)` Returns a `SearchResult` object that includes both the list of results like `search()` and the total length like `count()`.
`Object`	`searchUnique(ISearch search)` Search for a single result using the given parameters.

- Method Detail
  - find
```
<T> T find(Class<T> type,
         Serializable id)
```
    Get the entity with the specified type and id from the datastore.
    If none is found, return null.
  - find
```
<T> T[] find(Class<T> type,
           Serializable... ids)
```
    Get all entities of the specified type from the datastore that have one of these ids. An array of entities is returned that matches the same order of the ids listed in the call. For each entity that is not found in the datastore, a null will be inserted in its place in the return array.
  - getReference
```
<T> T getReference(Class<T> type,
                 Serializable id)
```
    Get a reference to the entity with the specified type and id from the datastore.
    This does not require a call to the datastore and does not populate any of the entity's values. Values may be fetched lazily at a later time. This increases performance if a another entity is being saved that should reference this entity but the values of this entity are not needed.
    
    Throws:
    
    a - HibernateException if no matching entity is found
  - getReferences
```
<T> T[] getReferences(Class<T> type,
                    Serializable... ids)
```
    Get a reference to the entities of the specified type with the given ids from the datastore. An array of entities is returned that matches the same order of the ids listed in the call.
    This does not require a call to the datastore and does not populate any of the entities' values. Values may be fetched lazily at a later time. This increases performance if a another entity is being saved that should reference these entities but the values of these entities are not needed.
    
    Throws:
    
    a - HibernateException if any of the matching entities are not found.
  - persist
```
void persist(Object... entities)
```
    Make a transient instance persistent and add it to the datastore. This operation cascades to associated instances if the association is mapped with cascade="persist". Throws an error if the entity already exists.
    Does not guarantee that the object will be assigned an identifier immediately. With persist a datastore-generated id may not be pulled until flush time.
  - merge
```
<T> T merge(T entity)
```
    Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved, save a copy and return it as a newly persistent instance.
    The instance that is passed in does not become associated with the session. This operation cascades to associated instances if the association is mapped with cascade="merge".
  - merge
```
Object[] merge(Object... entities)
```
    Copy the state of the given objects onto the persistent objects with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instances. If a given instance is unsaved, save a copy and return it as a newly persistent instance.
    The instances that are passed in do not become associated with the session. This operation cascades to associated instances if the association is mapped with cascade="merge".
  - save
```
<T> T save(T entity)
```
    If an entity with the same ID already exists in the database, merge the changes into that entity. If not persist the given entity. In either case, a managed entity with the changed values is returned. It may or may not be the same object as was passed in.
  - save
```
Object[] save(Object... entities)
```
    For each entity: If an entity with the same ID already exists in the database, merge the changes into that entity. If not persist the given entity. In either case, a managed entity with the changed values is returned. It may or may not be the same object as was passed in.
    
    Returns:
    an array containing each managed entity corresponding to the entities passed in.
  - remove
```
boolean remove(Object entity)
```
    Remove the specified entity from the datastore.
    
    Returns:
    true if the entity is found in the datastore and removed, false if it is not found.
  - remove
```
void remove(Object... entities)
```
    Remove all of the specified entities from the datastore.
  - removeById
```
boolean removeById(Class<?> type,
                 Serializable id)
```
    Remove the entity with the specified type and id from the datastore.
    
    Returns:
    true if the entity is found in the datastore and removed, false if it is not found.
  - removeByIds
```
void removeByIds(Class<?> type,
               Serializable... ids)
```
    Remove all the entities of the given type from the datastore that have one of these ids.
  - findAll
```
<T> List<T> findAll(Class<T> type)
```
    Get a list of all the objects of the specified type.
  - search
```
List search(ISearch search)
```
    Search for objects given the search parameters in the specified ISearch object.
  - searchUnique
```
Object searchUnique(ISearch search)
```
    Search for a single result using the given parameters.
  - count
```
int count(ISearch search)
```
    Returns the total number of results that would be returned using the given ISearch if there were no paging or maxResults limits.
  - searchAndCount
```
SearchResult searchAndCount(ISearch search)
```
    Returns a SearchResult object that includes both the list of results like search() and the total length like count().
  - isAttached
```
boolean isAttached(Object entity)
```
    Returns true if the object is connected to the current Hibernate session.
  - refresh
```
void refresh(Object... entities)
```
    Refresh the content of the given entity from the current datastore state.
  - flush
```
void flush()
```
    Flushes changes in the Hibernate session to the datastore.
  - getFilterFromExample
```
Filter getFilterFromExample(Object example)
```
    Generates a search filter from the given example using default options.
  - getFilterFromExample
```
Filter getFilterFromExample(Object example,
                          ExampleOptions options)
```
    Generates a search filter from the given example using the specified options.

Interface GeneralDAO

Method Summary

Method Detail

find

find

getReference

getReferences

persist

merge

merge

save

save

remove

remove

removeById

removeByIds

findAll

search

searchUnique

count

searchAndCount

isAttached

refresh

flush

getFilterFromExample

getFilterFromExample