BullhornDao

java.lang.Object
- com.client.core.soap.dao.BullhornDao<T>

Type Parameters:

T -

All Implemented Interfaces:

GenericDao<T,java.lang.Integer>
```
public class BullhornDao<T extends AbstractDto>
extends java.lang.Object
implements GenericDao<T,java.lang.Integer>
```
Encapsulates Bullhorn api calls in a GenericDao, this dao can then replace other GenericDaos when needed.

Constructor Summary

Constructors
Constructor and Description

BullhornDao(java.lang.Class<T> type)

Constructors
Constructor and Description
`BullhornDao(java.lang.Class<T> type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(T transientObject)` Adds an object of type T.
`void`	`batchMerge(java.util.List<T> listToMerge)` Handles batch insert or batch update.
`T`	`find(java.lang.Integer id)` Get a T record using it's id
`java.util.List<T>`	`findAll()` Gets a List of all entities in table
`BullhornAPI`	`getBullhornApi()`
`EntityIdHelper<T,java.lang.Integer>`	`getEntityIdHelper()` The entity id helper is used to get the id of the generic entity T.
`ApiEntityName`	`getEntityName()`
`java.lang.Class<T>`	`getType()`
`T`	`merge(T transientObject)` Adds or updates an object of type T
`java.lang.Integer`	`mergeAndReturnID(T transientObject)` Adds or updates an object of type T and returns the ID
`java.util.List<T>`	`query(java.lang.String whereClause)`
`java.util.List<T>`	`query(java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> queryParameters)` Query using the passed in query, with named parameters contained in the queryParameters.
`java.util.List<T>`	`query(java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> queryParameters, java.lang.Integer limit)` Query using the passed in query, with named parameters contained in the queryParameters.
`java.util.List<T>`	`query(java.lang.String queryString, java.util.Map<java.lang.String,java.lang.Object> queryParameters, java.lang.Integer limit, java.lang.Integer start)` Query using the passed in query, with named parameters contained in the queryParameters.
`void`	`remove(T persistentObject)` Deletes entity T from table.
`void`	`setBullhornApi(BullhornAPI bullhornApi)`
`void`	`setEntityManager(javax.persistence.EntityManager entityManager)` Added for testing

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BullhornDao
```
public BullhornDao(java.lang.Class<T> type)
```
- Method Detail
  - add
```
public void add(T transientObject)
```
    Description copied from interface: GenericDao
    
    Adds an object of type T.
    
    Specified by:
    
    add in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Parameters:
    
    transientObject - The object to be added
  - merge
```
public T merge(T transientObject)
```
    Description copied from interface: GenericDao
    
    Adds or updates an object of type T
    
    Specified by:
    
    merge in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Parameters:
    
    transientObject - The object to be added/updated
    
    Returns:
    
    the object just added/updated
  - mergeAndReturnID
```
public java.lang.Integer mergeAndReturnID(T transientObject)
```
    Description copied from interface: GenericDao
    
    Adds or updates an object of type T and returns the ID
    
    Specified by:
    
    mergeAndReturnID in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Parameters:
    
    transientObject - The object to be added/updated
    
    Returns:
    
    the ID of the object just added/updated
  - find
```
public T find(java.lang.Integer id)
       throws javax.persistence.EntityNotFoundException
```
    Description copied from interface: GenericDao
    
    Get a T record using it's id
    
    Specified by:
    
    find in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Parameters:
    
    id - the primary key of the entity
    
    Returns:
    
    the entity of type T
    
    Throws:
    
    javax.persistence.EntityNotFoundException - when no entity with unique identifier ID exists
  - findAll
```
public java.util.List<T> findAll()
```
    Description copied from interface: GenericDao
    
    Gets a List of all entities in table
    
    Specified by:
    
    findAll in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Returns:
    
    a List. If no entities exists an empty List will be returned.
  - remove
```
public void remove(T persistentObject)
            throws javax.persistence.EntityNotFoundException
```
    Description copied from interface: GenericDao
    
    Deletes entity T from table.
    
    Specified by:
    
    remove in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Parameters:
    
    persistentObject - Entity to delete
    
    Throws:
    
    javax.persistence.EntityNotFoundException - if the instance is not an entity or is a detached entity
  - query
```
public java.util.List<T> query(java.lang.String whereClause)
```
  - query
```
public java.util.List<T> query(java.lang.String queryString,
                               java.util.Map<java.lang.String,java.lang.Object> queryParameters)
```
    Description copied from interface: GenericDao
    
    Query using the passed in query, with named parameters contained in the queryParameters. If no queryParams needed pass in null for queryParams and have no named parameters in the query.
    
    Example: queryString = "SELECT * FROM Person p WHERE p.name = :name"; queryParam = Map containing "name":"Mr Toad"
    Do not concatenate the queryString with parameters before passing it in to this method! We should be using named parameters via the queryParamters to avoid SQL-injection attacks.
    
    Specified by:
    
    query in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Parameters:
    
    queryString - The query to execute, with named parameters if needed
    
    queryParameters - The parameters that will be used for the query. If null then query executes without params.
    
    Returns:
    
    a List of entities matching the passed in query
  - query
```
public java.util.List<T> query(java.lang.String queryString,
                               java.util.Map<java.lang.String,java.lang.Object> queryParameters,
                               java.lang.Integer limit)
```
    Description copied from interface: GenericDao
    
    Query using the passed in query, with named parameters contained in the queryParameters. If no queryParams needed pass in null for queryParams and have no named parameters in the query. Example: queryString = "SELECT * FROM Person p WHERE p.name = :name"; queryParam = Map containing "name":"Mr Toad"
    Do not concatenate the queryString with parameters before passing it in to this method! We should be using named parameters via the queryParamters to avoid SQL-injection attacks.
    
    Specified by:
    
    query in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Parameters:
    
    queryString - The query to execute, with named parameters if needed
    
    queryParameters - The parameters that will be used for the query. If null then query executes without params.
    
    limit - the maximum number of elements to return
    
    Returns:
    
    a List of entities matching the passed in query, with maximum size equal to the passed in limit
  - query
```
public java.util.List<T> query(java.lang.String queryString,
                               java.util.Map<java.lang.String,java.lang.Object> queryParameters,
                               java.lang.Integer limit,
                               java.lang.Integer start)
```
    Description copied from interface: GenericDao
    
    Query using the passed in query, with named parameters contained in the queryParameters. If no queryParams needed pass in null for queryParams and have no named parameters in the query. Example: queryString = "SELECT * FROM Person p WHERE p.name = :name"; queryParam = Map containing "name":"Mr Toad"
    Do not concatenate the queryString with parameters before passing it in to this method! We should be using named parameters via the queryParamters to avoid SQL-injection attacks.
    
    Specified by:
    
    query in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Parameters:
    
    queryString - The query to execute, with named parameters if needed
    
    queryParameters - The parameters that will be used for the query. If null then query executes without params.
    
    limit - the index of the record which we want to be the first returned based on the sort in the queryString
    
    start - the maximum number of elements to return
    
    Returns:
    
    a List of entities matching the passed in query, with maximum size equal to the passed in limit. The first element will be the [start]th element in the overall result set
  - setEntityManager
```
public void setEntityManager(javax.persistence.EntityManager entityManager)
```
    Description copied from interface: GenericDao
    
    Added for testing
    
    Specified by:
    
    setEntityManager in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Parameters:
    
    entityManager - the entityManager to set
  - getType
```
public java.lang.Class<T> getType()
```
  - getEntityName
```
public ApiEntityName getEntityName()
```
  - getBullhornApi
```
public BullhornAPI getBullhornApi()
```
  - setBullhornApi
```
public void setBullhornApi(BullhornAPI bullhornApi)
```
  - getEntityIdHelper
```
public EntityIdHelper<T,java.lang.Integer> getEntityIdHelper()
```
    The entity id helper is used to get the id of the generic entity T. Each type will need its own implementation of the EntityIdHelper to handle how to return the id.
    
    Returns:
  - batchMerge
```
public void batchMerge(java.util.List<T> listToMerge)
```
    Description copied from interface: GenericDao
    
    Handles batch insert or batch update.
    
    Specified by:
    
    batchMerge in interface GenericDao<T extends AbstractDto,java.lang.Integer>
    
    Parameters:
    
    listToMerge - the list of elements to merge

Class BullhornDao<T extends AbstractDto>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BullhornDao

Method Detail

add

merge

mergeAndReturnID

find

findAll

remove

query

query

query

query

setEntityManager

getType

getEntityName

getBullhornApi

setBullhornApi

getEntityIdHelper

batchMerge