Howto write an Adempiere process
From ADempiere
This Wiki is read-only for reference purposes to avoid broken links.
Here's a template process:
/****************************************************************************** * 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.math.BigDecimal; import java.util.Date; import org.compiere.model.PO; import org.compiere.process.ProcessInfoParameter; import org.compiere.process.SvrProcess; import org.eevolution.model.GenericPO; public class TemplateProcess extends SvrProcess { private boolean boolParam; private Date dateParam; private String rangeFrom; private String rangeTo; private int intParam; private BigDecimal bigDecParam; private PO record; /** * The prepare function is called first and is used to load parameters * which are passed to the process by the framework. Parameters to be * passed are configured in Report & Process -> Parameter. * */ @Override protected void prepare() { // Each Report & Process parameter name is set by the field DB Column Name for ( ProcessInfoParameter para : getParameter()) { if ( para.getParameterName().equals("isBooleanParam") ) boolParam = "Y".equals((String) para.getParameter()); // later versions can use getParameterAsString else if ( para.getParameterName().equals("dateParam") ) dateParam = (Date) para.getParameter(); // parameters may also specify the start and end value of a range else if ( para.getParameterName().equals("rangeParam") ) { rangeFrom = (String) para.getParameter(); rangeTo = (String) para.getParameter_To(); } else if ( para.getParameterName().equals("intParam") ) intParam = para.getParameterAsInt(); else if ( para.getParameterName().equals("bigDecParam") ) bigDecParam = (BigDecimal) para.getParameter(); else log.info("Parameter not found " + para.getParameterName()); } // you can also retrieve the id of the current record for processes called from a window int recordId = getRecord_ID(); if ( recordId > 0 ) record = new GenericPO(getCtx(), recordId, get_TrxName()); } /** * The doIt method is where your process does its work */ @Override protected String doIt() throws Exception { return "A message to the user (preferably indicating success or failure)"; } }