/*
    * Copyright 2007 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.vnd.businessobject;
  
  import java.sql.Date;
  import java.util.ArrayList;
  import java.util.LinkedHashMap;
  import java.util.List;
  
  import org.apache.commons.lang.builder.EqualsBuilder;
  import org.apache.log4j.Logger;
  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
  
  /**
   * Contains information specific to a parent Vendor, which may be shared by its division Vendors if it has any. Contained by a
   * <code>VendorDetail</code>.
   * 
   * @see org.kuali.ole.vnd.businessobject.VendorDetail
   */
  public class VendorHeader extends PersistableBusinessObjectBase {
      private static Logger LOG = Logger.getLogger(VendorHeader.class);
  
      private Integer vendorHeaderGeneratedIdentifier;
      private String vendorTypeCode;
      private String vendorTaxNumber;
      private String vendorTaxTypeCode;
      private String vendorOwnershipCode;
      private String vendorOwnershipCategoryCode;
      private Date vendorFederalWithholdingTaxBeginningDate;
      private Date vendorFederalWithholdingTaxEndDate;
      private Boolean vendorW9ReceivedIndicator;
      private Boolean vendorW8BenReceivedIndicator;
      private Boolean vendorDebarredIndicator;
      private Boolean vendorForeignIndicator;
  
      private VendorType vendorType;
      private OwnershipType vendorOwnership;
      private OwnershipCategory vendorOwnershipCategory;
      private List<VendorSupplierDiversity> vendorSupplierDiversities;
      private List<VendorTaxChange> vendorTaxChanges;
  
      /**
       * Default constructor.
       */
      public VendorHeader() {
          vendorSupplierDiversities = new ArrayList<VendorSupplierDiversity>();
      }
  
      public Integer getVendorHeaderGeneratedIdentifier() {
  
          return vendorHeaderGeneratedIdentifier;
      }
  
      public void setVendorHeaderGeneratedIdentifier(Integer vendorHeaderGeneratedIdentifier) {
          this.vendorHeaderGeneratedIdentifier = vendorHeaderGeneratedIdentifier;
      }
  
      public String getVendorTypeCode() {
  
          return vendorTypeCode;
      }
  
      public void setVendorTypeCode(String vendorTypeCode) {
          this.vendorTypeCode = vendorTypeCode;
      }
  
      public String getVendorTaxNumber() {
  
          return vendorTaxNumber;
      }
  
      public void setVendorTaxNumber(String vendorTaxNumber) {
          this.vendorTaxNumber = vendorTaxNumber;
      }
  
      public String getVendorTaxTypeCode() {
  
          return vendorTaxTypeCode;
      }
  
      public void setVendorTaxTypeCode(String vendorTaxTypeCode) {
          this.vendorTaxTypeCode = vendorTaxTypeCode;
      }
  
      public String getVendorOwnershipCode() {
 
         return vendorOwnershipCode;
     }
 
     public void setVendorOwnershipCode(String vendorOwnershipCode) {
         this.vendorOwnershipCode = vendorOwnershipCode;
     }
 
     public String getVendorOwnershipCategoryCode() {
 
         return vendorOwnershipCategoryCode;
     }
 
     public void setVendorOwnershipCategoryCode(String vendorOwnershipCategoryCode) {
         this.vendorOwnershipCategoryCode = vendorOwnershipCategoryCode;
     }
 
     public Date getVendorFederalWithholdingTaxBeginningDate() {
 
         return vendorFederalWithholdingTaxBeginningDate;
     }
 
     public void setVendorFederalWithholdingTaxBeginningDate(Date vendorFederalWithholdingTaxBeginningDate) {
         this.vendorFederalWithholdingTaxBeginningDate = vendorFederalWithholdingTaxBeginningDate;
     }
 
     public Date getVendorFederalWithholdingTaxEndDate() {
 
         return vendorFederalWithholdingTaxEndDate;
     }
 
     public void setVendorFederalWithholdingTaxEndDate(Date vendorFederalWithholdingTaxEndDate) {
         this.vendorFederalWithholdingTaxEndDate = vendorFederalWithholdingTaxEndDate;
     }
 
     public Boolean getVendorW9ReceivedIndicator() {
 
         return vendorW9ReceivedIndicator;
     }
 
     public void setVendorW9ReceivedIndicator(Boolean vendorW9ReceivedIndicator) {
         this.vendorW9ReceivedIndicator = vendorW9ReceivedIndicator;
     }
 
     public Boolean getVendorW8BenReceivedIndicator() {
 
         return vendorW8BenReceivedIndicator;
     }
 
     public void setVendorW8BenReceivedIndicator(Boolean vendorW8BenReceivedIndicator) {
         this.vendorW8BenReceivedIndicator = vendorW8BenReceivedIndicator;
     }
 
     public VendorType getVendorType() {
         // refresh because proxy doesn't work properly and vendor type sometimes is null
         if (vendorType == null)
             this.refreshReferenceObject("vendorType");
         return vendorType;
     }
 
     /**
      * Sets the vendorType attribute.
      * 
      * @param vendorType The vendorType to set.
      * @deprecated
      */
     public void setVendorType(VendorType vendorType) {
         this.vendorType = vendorType;
     }
 
     public OwnershipType getVendorOwnership() {
 
         return vendorOwnership;
     }
 
     /**
      * Sets the vendorOwnership attribute.
      * 
      * @param vendorOwnership The vendorOwnership to set.
      * @deprecated
      */
     public void setVendorOwnership(OwnershipType vendorOwnership) {
         this.vendorOwnership = vendorOwnership;
     }
 
     public OwnershipCategory getVendorOwnershipCategory() {
 
         return vendorOwnershipCategory;
     }
 
     /**
      * Sets the vendorOwnershipCategory attribute.
      * 
      * @param vendorOwnershipCategory The vendorOwnershipCategory to set.
      * @deprecated
      */
     public void setVendorOwnershipCategory(OwnershipCategory vendorOwnershipCategory) {
         this.vendorOwnershipCategory = vendorOwnershipCategory;
     }
 
     public Boolean getVendorDebarredIndicator() {
 
         return vendorDebarredIndicator;
     }
 
     /**
      * Sets the vendorDebarredIndicator attribute value.
      * 
      * @param vendorDebarredIndicator The vendorDebarredIndicator to set.
      */
     public void setVendorDebarredIndicator(Boolean vendorDebarredIndicator) {
         this.vendorDebarredIndicator = vendorDebarredIndicator;
     }
 
     public Boolean getVendorForeignIndicator() {
 
         return vendorForeignIndicator;
     }
 
     /**
      * Sets the vendorForeignIndicator attribute value.
      * 
      * @param vendorForeignIndicator The vendorForeignIndicator to set.
      */
     public void setVendorForeignIndicator(Boolean vendorForeignIndicator) {
         this.vendorForeignIndicator = vendorForeignIndicator;
     }
 
     public List<VendorSupplierDiversity> getVendorSupplierDiversities() {
 
         return vendorSupplierDiversities;
     }
 
     public void setVendorSupplierDiversities(List<VendorSupplierDiversity> vendorSupplierDiversities) {
         this.vendorSupplierDiversities = vendorSupplierDiversities;
     }
 
     /**
      * Used by the Spring Framework to correctly retrieve the vendor supplier diversities as a single
      * attribute. The vendorSupplierDiversities is a collection of diversities, and without this method, 
      * there was no way to get a single attribute for it.
      * 
      * @return the vendor supplier diversities as a single attribute
      */
     public String getVendorSupplierDiversitiesAsString() {
         StringBuilder sb = new StringBuilder("vendorSupplierDiversities=[");
 
         boolean first = true;
         for (VendorSupplierDiversity vsd : vendorSupplierDiversities) {
             if(vsd.isActive()){
             if (!first) {
                 sb.append(", ");
             } else {
                 first = false;
             }
                 sb.append(vsd.getVendorSupplierDiversity().getVendorSupplierDiversityDescription().toString());
             }
         }
         sb.append(']');
 
         return sb.toString();
     }
 
     public List<VendorTaxChange> getVendorTaxChanges() {
 
         return vendorTaxChanges;
     }
 
     public void setVendorTaxChanges(List<VendorTaxChange> vendorTaxChanges) {
         this.vendorTaxChanges = vendorTaxChanges;
     }
 
     /**
      * This method is a predicate to test equality of all the persisted attributes of an instance of this class, including member
      * collections. This is used to determine whether to route
      * 
      * @param vh Another VendorHeader object
      * @return True if all non-derived attributes of the given object are equal to this one's
      */
     public boolean isEqualForRouting(Object toCompare) {
         LOG.debug("Entering isEqualForRouting.");
         if (!(toCompare instanceof VendorHeader)) {
             return false;
         }
         else {
             VendorHeader vh = (VendorHeader) toCompare;
             return new EqualsBuilder().append(this.getVendorTypeCode(), vh.getVendorTypeCode()).append(this.getVendorTaxNumber(), vh.getVendorTaxNumber()).append(this.getVendorOwnershipCode(), vh.getVendorOwnershipCode()).append(this.getVendorOwnershipCategoryCode(), vh.getVendorOwnershipCategoryCode()).append(this.getVendorFederalWithholdingTaxBeginningDate(), vh.getVendorFederalWithholdingTaxBeginningDate()).append(this.getVendorFederalWithholdingTaxEndDate(), vh.getVendorFederalWithholdingTaxEndDate()).append(this.getVendorW9ReceivedIndicator(), vh.getVendorW9ReceivedIndicator()).append(this.getVendorW8BenReceivedIndicator(), vh.getVendorW8BenReceivedIndicator()).append(this.getVendorDebarredIndicator(), vh.getVendorDebarredIndicator()).append(this.getVendorForeignIndicator(), vh.getVendorForeignIndicator()).isEquals();
         }
     }
 
     /**
      * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
      */
     protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
         LinkedHashMap<String, String> m = new LinkedHashMap<String, String>();
         if (this.vendorHeaderGeneratedIdentifier != null) {
             m.put("vendorHeaderGeneratedIdentifier", this.vendorHeaderGeneratedIdentifier.toString());
         }
         return m;
     }
 }