/******************************************************************************
 * Product: Adempiere ERP & CRM Smart Business Solution                       *
 * Copyright (C) 1999-2006 ComPiere, Inc. All Rights Reserved.                *
 * This program is free software; you can redistribute it and/or modify it    *
 * under the terms version 2 of the GNU General Public License as published   *
 * by the Free Software Foundation. This program 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, write to the Free Software Foundation, Inc.,    *
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.                     *
 * For the text or an alternative of this public license, you may reach us    *
 * ComPiere, Inc., 2620 Augustine Dr. #245, Santa Clara, CA 95054, USA        *
 * or via info@compiere.org or http://www.compiere.org/license.html           *
 *****************************************************************************/
package org.compiere.process;

import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;

import org.compiere.model.MPeriod;
import org.compiere.model.MPeriodControl;
import org.compiere.model.MProcessPara;
import org.compiere.model.MRefList;
import org.compiere.model.MSysConfig;
import org.compiere.util.AdempiereUserError;
import org.compiere.util.CacheMgt;
import org.compiere.util.Env;
import org.compiere.util.Msg;
import org.compiere.util.ValueNamePair;


/**
 *	Open/Close Period Control
 *	
 *  @author Jorg Janke
 *  @version $Id: PeriodControlStatus.java,v 1.2 2006/07/30 00:51:02 jjanke Exp $
 */
@org.adempiere.base.annotation.Process
public class PeriodControlStatus extends SvrProcess
{
	/** Period Control				*/
	private List<Integer> p_C_PeriodControl_IDs;
	
	/**
	 *  Prepare - e.g., get Parameters.
	 */
	protected void prepare()
	{
		ProcessInfoParameter[] para = getParameter();
		for (int i = 0; i < para.length; i++)
		{
			String name = para[i].getParameterName();
			if (para[i].getParameter() == null)
				;
			else if (name.equals("*RecordIDs*"))
				;
			else
				MProcessPara.validateUnknownParameter(getProcessInfo().getAD_Process_ID(), para[i]);
		}
		p_C_PeriodControl_IDs = getRecord_IDs();
		if (p_C_PeriodControl_IDs == null || p_C_PeriodControl_IDs.size() == 0) {
			p_C_PeriodControl_IDs = new ArrayList<Integer>();
			p_C_PeriodControl_IDs.add(getRecord_ID());
		}
	}	//	prepare

	/**
	 * 	Process
	 *	@return message
	 *	@throws Exception
	 */
	protected String doIt() throws Exception
	{
		if (log.isLoggable(Level.INFO)) log.info ("C_PeriodControl_ID=" + p_C_PeriodControl_IDs);
		
		boolean hasUnpostedDocs = false;
		ArrayList<MPeriodControl> skipped = new ArrayList<MPeriodControl>();
		
		for (int p_C_PeriodControl_ID : p_C_PeriodControl_IDs) {
			MPeriodControl pc = new MPeriodControl (getCtx(), p_C_PeriodControl_ID, get_TrxName());
			if (pc.get_ID() == 0)
				throw new AdempiereUserError("@NotFound@  @C_PeriodControl_ID@=" + p_C_PeriodControl_ID);
			//	Permanently closed
			if (MPeriodControl.PERIODACTION_PermanentlyClosePeriod.equals(pc.getPeriodStatus()))
				throw new AdempiereUserError("@PeriodStatus@ = " + pc.getPeriodStatus());
			//	No Action
		
			MPeriod p = MPeriod.get(pc.getC_Period_ID());
			if ((   MPeriodControl.PERIODACTION_ClosePeriod.equalsIgnoreCase(pc.getPeriodAction())
				 || MPeriodControl.PERIODACTION_PermanentlyClosePeriod.equalsIgnoreCase(pc.getPeriodAction()))
				&& MSysConfig.getBooleanValue(MSysConfig.FORCE_POSTING_PRIOR_TO_PERIOD_CLOSE, true, getAD_Client_ID())
				&& p.hasUnpostedDocs(p_C_PeriodControl_ID)
				) {
				hasUnpostedDocs = true;
				skipped.add(pc);
				continue;
			}

			//	Open
			if (MPeriodControl.PERIODACTION_OpenPeriod.equals(pc.getPeriodAction()))
				pc.setPeriodStatus(MPeriodControl.PERIODSTATUS_Open);
			//	Close
			if (MPeriodControl.PERIODACTION_ClosePeriod.equals(pc.getPeriodAction()))
				pc.setPeriodStatus(MPeriodControl.PERIODSTATUS_Closed);
			//	Close Permanently
			if (MPeriodControl.PERIODACTION_PermanentlyClosePeriod.equals(pc.getPeriodAction()))
				pc.setPeriodStatus(MPeriodControl.PERIODSTATUS_PermanentlyClosed);
			pc.setPeriodAction(MPeriodControl.PERIODACTION_NoAction);
			//
			boolean ok = pc.save();
			
			//	Reset Cache
			CacheMgt.get().reset("C_Period", pc.getC_Period_ID());
	
			if (!ok)
				return "@Error@";
		}
		String returnVal = "@OK";
		
		// return the list of period controls with un-posted documents
		if (hasUnpostedDocs) {
			returnVal = Msg.getMsg(getCtx(), "CouldNotClosePeriodControl");
			for (MPeriodControl pc : skipped) {
				String displayValue = "a";
				for (ValueNamePair vnp : MRefList.getList(Env.getCtx(),MPeriodControl.DOCBASETYPE_AD_Reference_ID,false)) {
					if (vnp.getValue().equals(pc.getDocBaseType())) {
						displayValue = vnp.getName();
						break;
					}
				}
				addLog(pc.getC_PeriodControl_ID(), null, null, displayValue, MPeriodControl.Table_ID, pc.getC_PeriodControl_ID());
			}
		}
			
		CacheMgt.get().reset("C_PeriodControl", 0);
		return returnVal;
	}	//	doIt

}	//	PeriodControlStatus