/////////////////////////////////////////////////////////////////////////////
//
// Project ProjectForge Community Edition
// www.projectforge.org
//
// Copyright (C) 2001-2014 Kai Reinhard (k.reinhard@micromata.de)
//
// ProjectForge is dual-licensed.
//
// This community edition is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as published
// by the Free Software Foundation; version 3 of the License.
//
// This community edition is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
// Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, see http://www.gnu.org/licenses/.
//
/////////////////////////////////////////////////////////////////////////////
package org.projectforge.orga;
import java.util.List;
import org.apache.commons.lang.Validate;
import org.hibernate.criterion.Restrictions;
import org.projectforge.access.AccessException;
import org.projectforge.core.BaseDao;
import org.projectforge.core.BaseSearchFilter;
import org.projectforge.core.MessageParam;
import org.projectforge.core.MessageParamType;
import org.projectforge.core.QueryFilter;
import org.projectforge.core.UserException;
import org.projectforge.database.SQLHelper;
import org.projectforge.fibu.RechnungDO;
import org.projectforge.user.UserRightId;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;
/**
* @author Kai Reinhard (k.reinhard@micromata.de)
*
*/
public class ContractDao extends BaseDao<ContractDO>
{
public final static int START_NUMBER = 1000;
public static final UserRightId USER_RIGHT_ID = UserRightId.ORGA_CONTRACTS;
private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(ContractDao.class);
public ContractDao()
{
super(ContractDO.class);
userRightId = USER_RIGHT_ID;
}
@Override
@Transactional(readOnly = true, propagation = Propagation.SUPPORTS)
public List<ContractDO> getList(final BaseSearchFilter filter) throws AccessException
{
final ContractFilter myFilter;
if (filter instanceof ContractFilter) {
myFilter = (ContractFilter) filter;
} else {
myFilter = new ContractFilter(filter);
}
final QueryFilter queryFilter = new QueryFilter(myFilter);
if (myFilter.getStatus() != null) {
queryFilter.add(Restrictions.eq("status", myFilter.getStatus().name()));
}
if (myFilter.getType() != null) {
queryFilter.add(Restrictions.eq("type", myFilter.getType().getValue()));
}
queryFilter.setYearAndMonth("date", myFilter.getYear(), -1);
if (log.isDebugEnabled() == true) {
log.debug(myFilter.toString());
}
return getList(queryFilter);
}
/**
* List of all years with contracts: select min(date), max(date) from t_contract.
* @return
*/
@SuppressWarnings("unchecked")
public int[] getYears()
{
final List<Object[]> list = getSession().createQuery("select min(date), max(date) from ContractDO t").list();
return SQLHelper.getYears(list);
}
/**
* A given contract number must be consecutively numbered.
* @see org.projectforge.core.BaseDao#onSaveOrModify(org.projectforge.core.ExtendedBaseDO)
*/
@SuppressWarnings("unchecked")
@Override
protected void onSaveOrModify(final ContractDO obj)
{
if (obj.getNumber() == null) {
throw new UserException("validation.required.valueNotPresent", new MessageParam("legalAffaires.contract.number",
MessageParamType.I18N_KEY));
}
if (obj.getId() == null) {
// New contract
final Integer next = getNextNumber(obj);
if (next.intValue() != obj.getNumber().intValue()) {
throw new UserException("legalAffaires.contract.error.numberNotConsecutivelyNumbered");
}
} else {
final List<RechnungDO> list = getHibernateTemplate().find("from ContractDO c where c.number = ? and c.id <> ?",
new Object[] { obj.getNumber(), obj.getId()});
if (list != null && list.size() > 0) {
throw new UserException("legalAffaires.contract.error.numberAlreadyExists");
}
}
}
/**
* Gets the highest contract number.
* @param contract is needed to check wether the contract does already exist or not. If already exist it will be assured that this
* contract has an unchanged number.
*/
@SuppressWarnings("unchecked")
@Transactional(readOnly = true, propagation = Propagation.SUPPORTS)
public Integer getNextNumber(final ContractDO contract)
{
if (contract.getId() != null) {
final ContractDO orig = internalGetById(contract.getId());
if (orig.getNumber() != null) {
contract.setNumber(orig.getNumber());
return orig.getNumber();
}
}
final List<Integer> list = getSession().createQuery("select max(t.number) from ContractDO t").list();
Validate.notNull(list);
if (list.size() == 0 || list.get(0) == null) {
log.info("First entry of ContractDO");
return START_NUMBER;
}
final Integer number = list.get(0);
return number + 1;
}
@Override
public ContractDO newInstance()
{
return new ContractDO();
}
}