ItemTypeRule.java example

Explorer
kfs-master
/*
 * The Kuali Financial System, a comprehensive financial management system for higher education.
 * 
 * Copyright 2005-2014 The Kuali Foundation
 * 
 * This program 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, see <http://www.gnu.org/licenses/>.
 */
package org.kuali.kfs.module.purap.document.validation.impl;

import java.util.ArrayList;
import java.util.Collection;

import org.kuali.kfs.module.purap.PurapConstants;
import org.kuali.kfs.module.purap.PurapKeyConstants;
import org.kuali.kfs.module.purap.PurapParameterConstants;
import org.kuali.kfs.module.purap.PurapPropertyConstants;
import org.kuali.kfs.module.purap.businessobject.ItemType;
import org.kuali.kfs.module.purap.document.PaymentRequestDocument;
import org.kuali.kfs.module.purap.document.PurchaseOrderDocument;
import org.kuali.kfs.module.purap.document.RequisitionDocument;
import org.kuali.kfs.module.purap.document.VendorCreditMemoDocument;
import org.kuali.kfs.sys.KFSKeyConstants;
import org.kuali.kfs.sys.KFSPropertyConstants;
import org.kuali.kfs.sys.context.SpringContext;
import org.kuali.kfs.sys.service.impl.KfsParameterConstants;
import org.kuali.rice.coreservice.framework.parameter.ParameterService;
import org.kuali.rice.kns.document.MaintenanceDocument;
import org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase;
import org.kuali.rice.kns.service.BusinessObjectDictionaryService;

/* 
 * 
*/
public class ItemTypeRule extends MaintenanceDocumentRuleBase {

    protected boolean processCustomApproveDocumentBusinessRules(MaintenanceDocument document) {
        LOG.info("processCustomApproveDocumentBusinessRules called");
        this.setupConvenienceObjects();
        boolean success = this.checkForSystemParametersExistence();
        return success && super.processCustomApproveDocumentBusinessRules(document);
    }

    protected boolean processCustomRouteDocumentBusinessRules(MaintenanceDocument document) {
        LOG.info("processCustomRouteDocumentBusinessRules called");
        this.setupConvenienceObjects();
        boolean success = this.checkForSystemParametersExistence() && this.checkIndicators();
        return success && super.processCustomRouteDocumentBusinessRules(document);
    }

    protected boolean processCustomSaveDocumentBusinessRules(MaintenanceDocument document) {
        LOG.info("processCustomSaveDocumentBusinessRules called");
        this.setupConvenienceObjects();
        boolean success = this.checkForSystemParametersExistence();
        return success && super.processCustomSaveDocumentBusinessRules(document);
    }

    protected boolean checkForSystemParametersExistence() {
        LOG.info("checkForSystemParametersExistence called");
        boolean success = true;
        Collection<String> cmAdditionalCharges = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(VendorCreditMemoDocument.class, PurapConstants.BELOW_THE_LINES_PARAMETER) );
        Collection<String> preqAdditionalCharges = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PaymentRequestDocument.class, PurapConstants.BELOW_THE_LINES_PARAMETER) );
        Collection<String> poAdditionalCharges = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PurchaseOrderDocument.class, PurapConstants.BELOW_THE_LINES_PARAMETER) );
        Collection<String> reqAdditionalCharges = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(RequisitionDocument.class, PurapConstants.BELOW_THE_LINES_PARAMETER) );
        Collection<String> defaultNonQuantityItemTypes = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString( KfsParameterConstants.PURCHASING_DOCUMENT.class, PurapParameterConstants.DEFAULT_NON_QUANTITY_ITEM_TYPE) );
        Collection<String> defaultQuantityItemTypes = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(KfsParameterConstants.PURCHASING_DOCUMENT.class, PurapParameterConstants.DEFAULT_QUANTITY_ITEM_TYPE) );
        Collection<String> cmAllowNegative = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(VendorCreditMemoDocument.class, PurapConstants.ITEM_ALLOWS_NEGATIVE) );
        Collection<String> preqAllowNegative = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PaymentRequestDocument.class, PurapConstants.ITEM_ALLOWS_NEGATIVE) );
        Collection<String> poAllowNegative = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PurchaseOrderDocument.class, PurapConstants.ITEM_ALLOWS_NEGATIVE) );
        Collection<String> reqAllowNegative = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(RequisitionDocument.class, PurapConstants.ITEM_ALLOWS_NEGATIVE) );
        Collection<String> cmAllowPositive = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(VendorCreditMemoDocument.class, PurapConstants.ITEM_ALLOWS_POSITIVE) );
        Collection<String> preqAllowPositive = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PaymentRequestDocument.class, PurapConstants.ITEM_ALLOWS_POSITIVE) );
        Collection<String> poAllowPositive = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PurchaseOrderDocument.class, PurapConstants.ITEM_ALLOWS_POSITIVE) );
        Collection<String> reqAllowPositive = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(RequisitionDocument.class, PurapConstants.ITEM_ALLOWS_POSITIVE) );
        Collection<String> cmAllowZero = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(VendorCreditMemoDocument.class, PurapConstants.ITEM_ALLOWS_ZERO) );
        Collection<String> preqAllowZero = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PaymentRequestDocument.class, PurapConstants.ITEM_ALLOWS_ZERO) );
        Collection<String> poAllowZero = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PurchaseOrderDocument.class, PurapConstants.ITEM_ALLOWS_ZERO) );
        Collection<String> reqAllowZero = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(RequisitionDocument.class, PurapConstants.ITEM_ALLOWS_ZERO) );
        Collection<String> cmRequireDescription = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(VendorCreditMemoDocument.class, PurapConstants.ITEM_REQUIRES_USER_ENTERED_DESCRIPTION) );
        Collection<String> preqRequireDescription = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PaymentRequestDocument.class, PurapConstants.ITEM_REQUIRES_USER_ENTERED_DESCRIPTION) );
        Collection<String> poRequireDescription = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PurchaseOrderDocument.class, PurapConstants.ITEM_REQUIRES_USER_ENTERED_DESCRIPTION) );
        Collection<String> reqRequireDescription = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(RequisitionDocument.class, PurapConstants.ITEM_REQUIRES_USER_ENTERED_DESCRIPTION) );
        Collection<String> preqRestrictingAccountEdit = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PaymentRequestDocument.class, PurapParameterConstants.PURAP_ITEM_TYPES_RESTRICTING_ACCOUNT_EDIT) );
        Collection<String> poRestrictingAccountEdit = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(PurchaseOrderDocument.class, PurapParameterConstants.PURAP_ITEM_TYPES_RESTRICTING_ACCOUNT_EDIT) );
        Collection<String> reqRestrictingAccountEdit = new ArrayList<String>( SpringContext.getBean(ParameterService.class).getParameterValuesAsString(RequisitionDocument.class, PurapParameterConstants.PURAP_ITEM_TYPES_RESTRICTING_ACCOUNT_EDIT) );
        
        ItemType newBo = (ItemType)getNewBo();
        ItemType oldBo= (ItemType)getOldBo();
       
        if ((!newBo.isActive() && oldBo.isActive()) &&
             (cmAdditionalCharges.contains(newBo.getItemTypeCode()) || 
              preqAdditionalCharges.contains(newBo.getItemTypeCode()) ||
              poAdditionalCharges.contains(newBo.getItemTypeCode()) ||
              reqAdditionalCharges.contains(newBo.getItemTypeCode()) ||
              defaultNonQuantityItemTypes.contains(newBo.getItemTypeCode()) ||
              defaultQuantityItemTypes.contains(newBo.getItemTypeCode()) ||
              cmAllowNegative.contains(newBo.getItemTypeCode()) ||
              preqAllowNegative.contains(newBo.getItemTypeCode()) ||
              poAllowNegative.contains(newBo.getItemTypeCode()) ||
              reqAllowNegative.contains(newBo.getItemTypeCode()) ||
              cmAllowPositive.contains(newBo.getItemTypeCode()) ||
              preqAllowPositive.contains(newBo.getItemTypeCode()) ||
              poAllowPositive.contains(newBo.getItemTypeCode()) ||
              reqAllowPositive.contains(newBo.getItemTypeCode()) ||
              cmAllowZero.contains(newBo.getItemTypeCode()) ||
              preqAllowZero.contains(newBo.getItemTypeCode()) ||
              poAllowZero.contains(newBo.getItemTypeCode()) ||
              reqAllowZero.contains(newBo.getItemTypeCode()) ||
              cmRequireDescription.contains(newBo.getItemTypeCode()) ||
              preqRequireDescription.contains(newBo.getItemTypeCode()) ||
              poRequireDescription.contains(newBo.getItemTypeCode()) ||
              reqRequireDescription.contains(newBo.getItemTypeCode()) ||
              preqRestrictingAccountEdit.contains(newBo.getItemTypeCode()) ||
              poRestrictingAccountEdit.contains(newBo.getItemTypeCode()) ||
              reqRestrictingAccountEdit.contains(newBo.getItemTypeCode()) )
            ) {
            success = false;
            String documentLabel = SpringContext.getBean(BusinessObjectDictionaryService.class).getMaintainableLabel(newBo.getClass()); 
            putFieldError(KFSPropertyConstants.ACTIVE, KFSKeyConstants.ERROR_CANNOT_INACTIVATE_USED_IN_SYSTEM_PARAMETERS, documentLabel);
        }
        
        return success;
    }
    
    protected boolean checkIndicators() {
        
        boolean checkResult = true;
        ItemType newBo = (ItemType)getNewBo();
                
        // Both Quantity Based General Ledger Indicator and Additional Charge Indicator cannot be Yes at the same time
        if (newBo.isActive() && newBo.isAdditionalChargeIndicator() && newBo.isQuantityBasedGeneralLedgerIndicator()) {
            putFieldError(PurapPropertyConstants.ITEM_TYPE_QUANTITY_BASED, PurapKeyConstants.ERROR_ITEM_TYPE_QUANTITY_BASED_NOT_ALLOWED_WITH_ADDITIONAL_CHARGE);
            checkResult = false;
        }
        
        return checkResult;
    }
}