MaterialRequirementService.java

/**
 * ***************************************************************************
 * Copyright (c) 2010 Qcadoo Limited
 * Project: Qcadoo MES
 * Version: 1.4
 *
 * This file is part of Qcadoo.
 *
 * Qcadoo is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ***************************************************************************
 */
package com.qcadoo.mes.materialRequirements;

import java.io.IOException;
import java.math.BigDecimal;
import java.util.List;
import java.util.Map;

import org.springframework.stereotype.Service;

import com.lowagie.text.DocumentException;
import com.qcadoo.mes.technologies.constants.MrpAlgorithm;
import com.qcadoo.model.api.DataDefinition;
import com.qcadoo.model.api.Entity;
import com.qcadoo.view.api.ComponentState;

@Service
public interface MaterialRequirementService {

    /**
     * Check if input products required for type is selected
     * 
     * @param entityDD
     *            parameterDD or orderDD
     * 
     * @param entity
     *            parameter or order
     * 
     * @param fieldName
     * 
     * @param errorMessage
     * 
     * @return boolean
     * 
     */
    boolean checkIfInputProductsRequiredForTypeIsSelected(final DataDefinition entityDD, final Entity entity,
            final String fieldName, final String errorMessage);

    /**
     * Sets input products required for type default value
     * 
     * @param entity
     *            parameter or order
     * 
     * @param fieldName
     * 
     * @param fieldValue
     * 
     */
    void setInputProductsRequiredForTypeDefaultValue(final Entity entity, final String fieldName, final String fieldValue);

    /**
     * Gets default MRP Algorithm
     * 
     * @return mrpAlgorithm
     * 
     */
    MrpAlgorithm getDefaultMrpAlgorithm();

    /**
     * Generates material requirement documents
     * 
     * @param state
     *            state
     * @param materialRequirement
     *            material requirement
     * 
     * @throws IOException
     */
    void generateMaterialRequirementDocuments(final ComponentState state, final Entity materialRequirement) throws IOException,
            DocumentException;


}