JavaDoc da Classe Controller


Para visualizar a documentação completa, acesse: http://jbc.orgfree.com/

insert

public java.lang.Boolean insert(T obj)
                         throws java.lang.Exception
Insere um registro em uma determinada tabela
Parameters:
obj - Objeto VO de persistência
Returns:
Boolean.True para transação com sucesso e Boolean.False para transação com Rollback
Throws:
java.lang.Exception



insert

public java.lang.Boolean insert(java.util.List<T> objList)
                         throws java.lang.Exception
Insere uma lista de registros em uma determinada tabela
Parameters:
objList - Lista de Objetos VO de persistência
Returns:
Boolean.True para transação com sucesso e Boolean.False para transação com Rollback
Throws:
java.lang.Exception



insertOrUpdate

public java.lang.Boolean insertOrUpdate(T obj)
                                 throws java.lang.Exception
Insere ou atualiza um registro em uma determinada tabela
Parameters:
obj - Objeto VO de persistência
Returns:
Boolean.True para transação com sucesso e Boolean.False para transação com Rollback
Throws:
java.lang.Exception



insertOrUpdate

public java.lang.Boolean insertOrUpdate(java.util.List<T> objList)
                                 throws java.lang.Exception
Insere ou atualiza uma lista de registros em uma determinada tabela
Parameters:
objList - Lista de Objetos VO de persistência
Returns:
Boolean.True para transação com sucesso e Boolean.False para transação com Rollback
Throws:
java.lang.Exception



insertReturnId

public T insertReturnId(T obj)
                 throws java.lang.Exception
Insere um registro em uma determinada tabela e retorna a entidade persistida
Parameters:
obj - Objeto VO de persistência
Returns:
O Objeto Persistido
Throws:
java.lang.Exception



update

public java.lang.Boolean update(T obj)
                         throws java.lang.Exception
Atualiza um registro em uma determinada tabela
Parameters:
obj - Objeto VO de persistência
Returns:
Boolean.True para transação com sucesso e Boolean.False para transação com Rollback
Throws:
java.lang.Exception



update

public java.lang.Boolean update(java.util.List<T> objList)
                         throws java.lang.Exception
Atualiza uma lista de registros em uma determinada tabela
Parameters:
objList - Lista de Objetos VO de persistência
Returns:
Boolean.True para transação com sucesso e Boolean.False para transação com Rollback
Throws:
java.lang.Exception



delete

public java.lang.Boolean delete(T obj)
                         throws java.lang.Exception
Elimina um determinado registro pelo Objeto
Parameters:
obj - Objeto VO a ser eliminado contendo a sua chave primária
Returns:
Boolean.True para transação com sucesso e Boolean.False para transação com Rollback
Throws:
java.lang.Exception



delete

public java.lang.Boolean delete(java.util.List<T> objList)
                         throws java.lang.Exception
Elimina uma lista de registros
Parameters:
objList - Objeto VO a ser eliminado contendo a sua chave primária
Returns:
Boolean.True para transação com sucesso e Boolean.False para transação com Rollback
Throws:
java.lang.Exception



findList

public java.util.List<T> findList(T filter)
                           throws java.lang.Exception
Lista os registro de uma determinada tabela
Parameters:
filter - Objeto VO contendo os filtros de consulta populados em seus atributos
Returns:
Lista de objetos encontrados na consulta
Throws:
java.lang.Exception



findList

public java.util.List<T> findList(T filter,
                                  int searchType)
                           throws java.lang.Exception
Lista os registro de uma determinada tabela, sendo que pode ser informado o tipo de consulta
Parameters:
filter - Objeto VO contendo os filtros de consulta populados em seus atributos
searchType - Tipo de pesquisa que será feita a consulta no banco de dados, sendo Controller.SEARCH_LIKE_STRING E Controller.SEARCH_EQUALS_STRING
Returns:
Lista de objetos encontrados na consulta
Throws:
java.lang.Exception




find

public T find(T filter)
       throws java.lang.Exception
Retorna um registro de uma determinada tabela
Parameters:
filter - Objeto VO contendo os filtros de consulta populados em seus atributos
Returns:
Objeto encontrado na consulta
Throws:
java.lang.Exception



find

public T find(T filter,
              int searchType)
       throws java.lang.Exception
Retorna um registro de uma determinada tabela, sendo que pode ser informado o tipo de consulta
Parameters:
filter - Objeto VO contendo os filtros de consulta populados em seus atributos
searchType - Tipo de pesquisa que será feita a consulta no banco de dados, sendo Controller.SEARCH_LIKE_STRING E Controller.SEARCH_EQUALS_STRING
Returns:
Objeto encontrado na consulta
Throws:
java.lang.Exception




findById

public T findById(java.lang.Class clazz,
                  java.lang.Number id)
           throws java.lang.Exception
Procura um registro por um ID
Parameters:
id - Chave primária da entidade
Returns:
Objeto encontrado na consulta
Throws:
java.lang.Exception



getListByHQLCondition

public java.util.List<T> getListByHQLCondition(java.lang.String condition)
                                        throws java.lang.Exception
Busca uma lista de registro por uma condição HQL
Parameters:
condition - Condição HQL
Returns:
Lista de objetos encontrados na consulta
Throws:
java.lang.Exception



getListByHQLCondition

public java.util.List<T> getListByHQLCondition(java.lang.String condition,
                                               java.util.List paramList,
                                               java.lang.String paramListName)
                                        throws java.lang.Exception
Busca uma lista de registro por uma condição HQL com uma lista de parametros
Parameters:
condition - Condição HQL
paramList - Lista de parametros passada para a Query HQL
paramListName - Nome da lista de parametros
Returns:
Lista de objetos encontrados na consulta
Throws:
java.lang.Exception





getListByHQLCondition

public java.util.List<T> getListByHQLCondition(java.lang.String condition,
                                               int firstResult,
                                               int maxResult)
                                        throws java.lang.Exception
Busca uma lista de registro por uma condição HQL paginada
Parameters:
condition - Condição HQL
firstResult - Número da página que a consulta irá mostrar os resultados
maxResult - Número de registros por página
Returns:
Lista de objetos encontrados na consulta
Throws:
java.lang.Exception





getListByHQLCondition

public java.util.List<T> getListByHQLCondition(java.lang.String condition,
                                               java.util.List paramList,
                                               java.lang.String paramListName,
                                               int firstResult,
                                               int maxResult)
                                        throws java.lang.Exception
Busca uma lista de registro por uma condição HQL paginada com uma lista de parametros
Parameters:
condition - Condição HQL
paramList - Lista de parametros passada para a Query HQL
paramListName - Nome da lista de parametros
firstResult - Número da página que a consulta irá mostrar os resultados
maxResult - Número de registros por página
Returns:
Lista de objetos encontrados na consulta
Throws:
java.lang.Exception







getObjectByHQLCondition

public T getObjectByHQLCondition(java.lang.String condition)
                          throws java.lang.Exception
Busca um registro por uma condição HQL
Parameters:
condition - Condição HQL
Returns:
Objeto encontrado na consulta
Throws:
java.lang.Exception



getValueByHQLCondition

public java.lang.Object getValueByHQLCondition(java.lang.String condition)
                                        throws java.lang.Exception
Busca um valor de um registro por uma condição HQL, podendo ser um tipo primitivo, ou qualquer valor que a condição HQL retorne
Parameters:
condition - Condição HQL
Returns:
Valor encontrado na consulta
Throws:
java.lang.Exception



findPaginate

public SearchPaginate findPaginate(T filter,
                                   int firstResult,
                                   int maxResult,
                                   java.lang.String sortField,
                                   boolean orderByType)
                            throws java.lang.Exception
Realiza uma consulta paginada com filtro passado por parametro
Parameters:
filter - Objeto VO contendo os filtros de consulta populados em seus atributos
firstResult - Número da página que a consulta irá mostrar os resultados
maxResult - Número de registros por página
sortField - Nome do atributo da entidade que será ordenado
orderByType - Tipo de ordenação da Lista, os valores devem ser Controller.ORDER_ASC ou Controller.ORDER_DESC
Returns:
Componente SearchPaginate contendo a lista páginada e a quantidade total de registros daquela tabela
Throws:
java.lang.Exception







getMax

public java.lang.Number getMax(T filter,
                               java.lang.String field)
Retornar o valor máximo de acordo com o campo da tabela
Parameters:
filter - Objeto VO contendo os filtros de consulta populados em seus atributos
field - Nome do atributo da entidade que será pesquisado
Returns:
Valor máximo



getMin

public java.lang.Number getMin(T filter,
                               java.lang.String field)
metodo que retornar o valor minimo de acordo com o campo da tabela
Parameters:
filter - Objeto VO contendo os filtros de consulta populados em seus atributos
field - Nome do atributo da entidade que será pesquisado
Returns:
Valor mínimo



getCountRecords

public java.lang.Integer getCountRecords(T filter)
                                  throws java.lang.Exception
Busca o total de registros de uma determinada tabela
Parameters:
filter - Objeto VO contendo os filtros de consulta populados em seus atributos
Returns:
Quantidade de registros
Throws:
java.lang.Exception


Para baixar a documentação completa, acesse: http://jbc.orgfree.com/





Nenhum comentário:

Postar um comentário

Muito obrigado por contribuir com o JBC!