/*
    * Copyright 2008 The Kuali Foundation
    * 
    * Licensed under the Educational Community License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * 
    * http://www.opensource.org/licenses/ecl2.php
    * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.kuali.ole.integration.cab;
  
  import java.util.List;
  
  import org.kuali.ole.fp.businessobject.CapitalAssetInformation;
  import org.kuali.ole.integration.purap.ExternalPurApItem;
  import org.kuali.ole.integration.purap.ItemCapitalAsset;
  import org.kuali.ole.sys.businessobject.AccountingLine;
  import org.kuali.ole.sys.document.AccountingDocument;
  import org.kuali.ole.sys.document.OLEAccountingDocument;
  import org.kuali.rice.krad.bo.DocumentHeader;
  
  public interface CapitalAssetBuilderModuleService {
      /**
       * Check the existence of asset type code
       * 
       * @param assetTypeCode
       * @return
       */
      public boolean isAssetTypeExisting(String assetTypeCode);
      /**
       * Get current Purchase Order Document number for given CAMS Document Number
       * 
       * @param camsDocumentNumber
       * @return
       */
      String getCurrentPurchaseOrderDocumentNumber(String camsDocumentNumber);
  
      /**
       * validate the capitalAssetManagementAsset data associated with the given accounting document
       * 
       * @param accountingDocument the given accounting document
       * @param capitalAssetManagementAsset data to be validated
       * @return validation succeeded or errors present
       */
      public boolean validateFinancialProcessingData(AccountingDocument accountingDocument, CapitalAssetInformation capitalAssetInformation, int index);
  
  
      public boolean validatePurchasingData(AccountingDocument accountingDocument);
  
      public boolean validatePurchasingData(OLEAccountingDocument accountingDocument);
  
      public boolean validateAccountsPayableData(AccountingDocument accountingDocument);
  
      public boolean doesAccountingLineFailAutomaticPurchaseOrderRules(AccountingLine accountingLine);
  
      public boolean doesDocumentFailAutomaticPurchaseOrderRules(AccountingDocument accountingDocument);
  
      public boolean doesDocumentFailAutomaticPurchaseOrderRules(OLEAccountingDocument accountingDocument);
  
      public boolean doesItemNeedCapitalAsset(String itemTypeCode, List accountingLines);
  
      public boolean validateUpdateCAMSView(AccountingDocument accountingDocumen);
      public boolean validateUpdateCAMSView(OLEAccountingDocument accountingDocumen);
  
      public boolean validateAddItemCapitalAssetBusinessRules(ItemCapitalAsset asset);
  
      public boolean warningObjectLevelCapital(AccountingDocument accountingDocument);
  
      public boolean validateItemCapitalAssetWithErrors(String recurringPaymentTypeCode, ExternalPurApItem item, boolean apoCheck);
  
      public List<CapitalAssetBuilderAssetTransactionType> getAllAssetTransactionTypes();
  
      /**
       * External modules can notify CAB if a document changed its route status. CAB Uses this notification to release records or to
       * update other modules about the changes
       * 
       * @param documentHeader DocumentHeader
       */
      public void notifyRouteStatusChange(DocumentHeader documentHeader);
  
  
      /**
       * determine whether there is any object code of the given source accounting lines with a capital asset object sub type
       * 
       * @param accountingLines the given source accounting lines
       * @return true if there is at least one object code of the given source accounting lines with a capital asset object sub type;
       *         otherwise, false
       */
      public boolean hasCapitalAssetObjectSubType(AccountingDocument accountingDocument);
      
      public boolean validateAllFieldRequirementsByChart(AccountingDocument accountingDocument);
  
      public boolean validateAllFieldRequirementsByChart(OLEAccountingDocument accountingDocument);
 
     public boolean validatePurchasingObjectSubType(AccountingDocument accountingDocument);
 
     public boolean validatePurchasingObjectSubType(OLEAccountingDocument accountingDocument);
 
     public boolean hasCapitalAssetObjectSubType(AccountingLine accountingLine);
     
     public boolean validateAssetTags(AccountingDocument accountingDocument);
     
     /**
      * validates all capital accounting lines that have been processed.
      * 
      * @param accountingDocumentForValidation
      * @return true if all lines have been processes else return false
      */
     public boolean validateAllCapitalAccountingLinesProcessed(AccountingDocument accountingDocumentForValidation);    
     
     /**
      * determine whether the given document's all capital accounting lines totals
      * match to that of capital assets.
      * @param accountingDocumentForValidation
      * @return true if totals match else return false
      */
     public boolean validateTotalAmountMatch(AccountingDocument accountingDocumentForValidation);
     
     /**
      * determine whether the any capital accounting line's amount matches
      * with all the capital assets for that capital accounting line.
      * 
      * @param accountingDocument
      * @return true if totals match else return false
      */
     public boolean validateCapitlAssetsAmountToAccountingLineAmount(AccountingDocument accountingDocument);
     
     /**
      * validates whether capital assets exist for any given capital accounting line.
      * @param accountingDocumentForValidation
      * @return true if capital assets exist for capital accounting line else return false.
      */
     public boolean validateCapitalAccountingLines(AccountingDocument accountingDocumentForValidation);    
     
     /**
      * mark the gl entry line if all the capital asset lines have been processed
      * @param documentNumber
      * @return true if gl entry line marked as processed else return false.
      */
     public boolean markProcessedGLEntryLine(String documentNumber);   
 }