org.egov.works.services

Interface BaseService<T,ID extends Serializable>

Type Parameters:

T - type variable

ID - primary key for the type T

All Known Subinterfaces:

ContractorBillService, DepositWorksUsageService, MeasurementBookService, RevisionEstimateService, WorkOrderService, WorksPackageService

All Known Implementing Classes:

BaseServiceImpl, ContractorBillServiceImpl, DepositWorksUsageServiceImpl, MeasurementBookServiceImpl, RevisionEstimateServiceImpl, WorkOrderServiceImpl, WorksPackageServiceImpl

public interface BaseService<T,ID extends Serializable>

Base service class which will talk to PersistenceService

Author:

prashant.gaurav

Method Summary

Modifier and Type	Method and Description
T	create(T entity) Generic method to save an object.
void	delete(T entity) Generic method to delete an object based on class and id
T	find(String query) Find object by query.
T	find(String query, Object... params) Find object by query and parameter.
List<T>	findAll() Generic method used to get all objects of a particular type.
List<T>	findAllBy(String query, Object... params) Find list of object by query and parameter.
List<T>	findAllByNamedQuery(String namedQuery, Object... params) Find list of object by query and parameter.
List<T>	findByExample(T exampleT) Generic method to search similar objects.
T	findById(ID id, boolean lock) Generic method to get an object based on class and identifier.
T	findByNamedQuery(String namedQuery, Object... params) find object by named query and parameter.
org.egov.commons.CFinancialYear	getCurrentFinancialYear(Date date) This method retrieves the CFinancialYear for the given date.
T	merge(T model) Generic method to merge entity
T	persist(T entity) Generic method to validate and save/update the entity
T	update(T entity) Generic method to update an object.

Method Detail

findById

T findById(ID id,
           boolean lock)

Generic method to get an object based on class and identifier. An ObjectRetrievalFailureException Runtime Exception is thrown if nothing is found.

Parameters:

id -

lock -

Returns:

findAll

List<T> findAll()

Generic method used to get all objects of a particular type. This is the same as lookup up all rows in a table.

Returns:

list of objects.

findByExample

List<T> findByExample(T exampleT)

Generic method to search similar objects.

Parameters:

exampleT -

Returns:

create

T create(T entity)

Generic method to save an object.

Parameters:

entity -

Returns:

the created

persist

T persist(T entity)

Generic method to validate and save/update the entity

Parameters:

entity -

Returns:

merge

T merge(T model)

Generic method to merge entity

Parameters:

model -

Returns:

delete

void delete(T entity)

Generic method to delete an object based on class and id

Parameters:

entity -

update

T update(T entity)

Generic method to update an object.

Parameters:

entity -

Returns:

the updated object

find

T find(String query,
       Object... params)

Find object by query and parameter.

Parameters:

query -

params -

Returns:

object.

find

T find(String query)

Find object by query.

Parameters:

query -

Returns:

object.

findAllBy

List<T> findAllBy(String query,
                  Object... params)

Find list of object by query and parameter.

Parameters:

query -

params -

Returns:

List of object

findAllByNamedQuery

List<T> findAllByNamedQuery(String namedQuery,
                            Object... params)

Find list of object by query and parameter.

Parameters:

namedQuery -

params -

Returns:

List of object

findByNamedQuery

T findByNamedQuery(String namedQuery,
                   Object... params)

find object by named query and parameter.

Parameters:

namedQuery -

params -

Returns:

object.

getCurrentFinancialYear

org.egov.commons.CFinancialYear getCurrentFinancialYear(Date date)

This method retrieves the CFinancialYear for the given date.

Parameters:

date - an instance of Date for which the financial year is to be retrieved.

Returns:

CFinancialYear