/*
    * Copyright 2005 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.fp.businessobject;
  
  import java.util.LinkedHashMap;
  
  import org.kuali.ole.fp.businessobject.options.TaxIncomeClassValuesFinder;
  import org.kuali.ole.sys.OLEPropertyConstants;
  import org.kuali.rice.core.api.util.type.KualiDecimal;
  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
  
  /**
   * This class is used to represent a disbursement voucher non-resident alien tax.
   */
  public class DisbursementVoucherNonResidentAlienTax extends PersistableBusinessObjectBase {
  
      private String documentNumber;
      private KualiDecimal federalIncomeTaxPercent;
      private KualiDecimal stateIncomeTaxPercent;
      private String incomeClassCode;
      private String postalCountryCode;
      private boolean incomeTaxTreatyExemptCode;
      private boolean foreignSourceIncomeCode;
      private boolean incomeTaxGrossUpCode;
      private String referenceFinancialSystemOriginationCode;
      private String referenceFinancialDocumentNumber;
      private String financialDocumentAccountingLineText;
      private String taxNQIId;
      private boolean taxOtherExemptIndicator;
      private boolean taxUSAIDPerDiemIndicator;
      protected KualiDecimal taxSpecialW4Amount;
  
      private TaxIncomeClassCode incomeClass;
  
      /**
       * Default no-arg constructor.
       */
      public DisbursementVoucherNonResidentAlienTax() {
  
      }
  
      /**
       * Gets the documentNumber attribute.
       * 
       * @return Returns the documentNumber
       */
      public String getDocumentNumber() {
          return documentNumber;
      }
  
  
      /**
       * Sets the documentNumber attribute.
       * 
       * @param documentNumber The documentNumber to set.
       */
      public void setDocumentNumber(String documentNumber) {
          this.documentNumber = documentNumber;
      }
  
      /**
       * Gets the federalIncomeTaxPercent attribute.
       * 
       * @return Returns the federalIncomeTaxPercent
       */
      public KualiDecimal getFederalIncomeTaxPercent() {
          return federalIncomeTaxPercent;
      }
  
  
      /**
       * Sets the federalIncomeTaxPercent attribute.
       * 
       * @param federalIncomeTaxPercent The federalIncomeTaxPercent to set.
       */
      public void setFederalIncomeTaxPercent(KualiDecimal federalIncomeTaxPercent) {
          this.federalIncomeTaxPercent = federalIncomeTaxPercent;
      }
  
      /**
       * Gets the stateIncomeTaxPercent attribute.
       * 
       * @return Returns the stateIncomeTaxPercent
       */
      public KualiDecimal getStateIncomeTaxPercent() {
         return stateIncomeTaxPercent;
     }
 
 
     /**
      * Sets the stateIncomeTaxPercent attribute.
      * 
      * @param stateIncomeTaxPercent The stateIncomeTaxPercent to set.
      */
     public void setStateIncomeTaxPercent(KualiDecimal stateIncomeTaxPercent) {
         this.stateIncomeTaxPercent = stateIncomeTaxPercent;
     }
 
     /**
      * Gets the incomeClassCode attribute.
      * 
      * @return Returns the incomeClassCode
      */
     public String getIncomeClassCode() {
         return incomeClassCode;
     }
 
 
     /**
      * Sets the incomeClassCode attribute.
      * 
      * @param incomeClassCode The incomeClassCode to set.
      */
     public void setIncomeClassCode(String incomeClassCode) {
         this.incomeClassCode = incomeClassCode;
     }
 
     /**
      * Gets the postalCountryCode attribute.
      * 
      * @return Returns the postalCountryCode
      */
     public String getPostalCountryCode() {
         return postalCountryCode;
     }
 
 
     /**
      * Sets the postalCountryCode attribute.
      * 
      * @param postalCountryCode The postalCountryCode to set.
      */
     public void setPostalCountryCode(String postalCountryCode) {
         this.postalCountryCode = postalCountryCode;
     }
 
     /**
      * Gets the incomeTaxTreatyExemptCode attribute.
      * 
      * @return Returns the incomeTaxTreatyExemptCode
      */
     public boolean isIncomeTaxTreatyExemptCode() {
         return incomeTaxTreatyExemptCode;
     }
 
 
     /**
      * Sets the incomeTaxTreatyExemptCode attribute.
      * 
      * @param incomeTaxTreatyExemptCode The incomeTaxTreatyExemptCode to set.
      */
     public void setIncomeTaxTreatyExemptCode(boolean incomeTaxTreatyExemptCode) {
         this.incomeTaxTreatyExemptCode = incomeTaxTreatyExemptCode;
     }
 
     /**
      * Gets the foreignSourceIncomeCode attribute.
      * 
      * @return Returns the foreignSourceIncomeCode
      */
     public boolean isForeignSourceIncomeCode() {
         return foreignSourceIncomeCode;
     }
 
 
     /**
      * Sets the foreignSourceIncomeCode attribute.
      * 
      * @param foreignSourceIncomeCode The foreignSourceIncomeCode to set.
      */
     public void setForeignSourceIncomeCode(boolean foreignSourceIncomeCode) {
         this.foreignSourceIncomeCode = foreignSourceIncomeCode;
     }
 
     /**
      * Gets the incomeTaxGrossUpCode attribute.
      * 
      * @return Returns the incomeTaxGrossUpCode
      */
     public boolean isIncomeTaxGrossUpCode() {
         return incomeTaxGrossUpCode;
     }
 
 
     /**
      * Sets the incomeTaxGrossUpCode attribute.
      * 
      * @param incomeTaxGrossUpCode The incomeTaxGrossUpCode to set.
      */
     public void setIncomeTaxGrossUpCode(boolean incomeTaxGrossUpCode) {
         this.incomeTaxGrossUpCode = incomeTaxGrossUpCode;
     }
 
     /**
      * Gets the referenceFinancialSystemOriginationCode attribute.
      * 
      * @return Returns the referenceFinancialSystemOriginationCode
      */
     public String getReferenceFinancialSystemOriginationCode() {
         return referenceFinancialSystemOriginationCode;
     }
 
 
     /**
      * Sets the referenceFinancialSystemOriginationCode attribute.
      * 
      * @param referenceFinancialSystemOriginationCode The referenceFinancialSystemOriginationCode to set.
      */
     public void setReferenceFinancialSystemOriginationCode(String referenceFinancialSystemOriginationCode) {
         this.referenceFinancialSystemOriginationCode = referenceFinancialSystemOriginationCode;
     }
 
     /**
      * Gets the referenceFinancialDocumentNumber attribute.
      * 
      * @return Returns the referenceFinancialDocumentNumber
      */
     public String getReferenceFinancialDocumentNumber() {
         return referenceFinancialDocumentNumber;
     }
 
 
     /**
      * Sets the referenceFinancialDocumentNumber attribute.
      * 
      * @param referenceFinancialDocumentNumber The referenceFinancialDocumentNumber to set.
      */
     public void setReferenceFinancialDocumentNumber(String referenceFinancialDocumentNumber) {
         this.referenceFinancialDocumentNumber = referenceFinancialDocumentNumber;
     }
 
     /**
      * @return Returns the financialDocumentAccountingLineText.
      */
     public String getFinancialDocumentAccountingLineText() {
         return financialDocumentAccountingLineText;
     }
 
     /**
      * @param financialDocumentAccountingLineText The financialDocumentAccountingLineText to set.
      */
     public void setFinancialDocumentAccountingLineText(String financialDocumentAccountingLineText) {
         this.financialDocumentAccountingLineText = financialDocumentAccountingLineText;
     }
 
     /**
      * Gets the taxNQIId attribute.
      * 
      * @return Returns the taxNQIId.
      */
     public String getTaxNQIId() {
         return taxNQIId;
     }
 
     /**
      * Gets the taxOtherExemptIndicator attribute.
      * 
      * @return Returns the taxOtherExemptIndicator.
      */
     public boolean isTaxOtherExemptIndicator() {
         return taxOtherExemptIndicator;
     }
 
     /**
      * Gets the taxUSAIDPerDiemIndicator attribute.
      * 
      * @return Returns the taxUSAIDPerDiemIndicator.
      */
     public boolean isTaxUSAIDPerDiemIndicator() {
         return taxUSAIDPerDiemIndicator;
     }
 
     /**
      * Gets the taxSpecialW4Amount attribute.
      * 
      * @return Returns the taxSpecialW4Amount.
      */
     public KualiDecimal getTaxSpecialW4Amount() {
         return taxSpecialW4Amount;
     }
 
     /**
      * Sets the taxNQIId attribute value.
      * 
      * @param taxNQIId The taxNQIId to set.
      */
     public void setTaxNQIId(String taxNQIId) {
         this.taxNQIId = taxNQIId;
     }
 
     /**
      * Sets the taxOtherExemptIndicator attribute value.
      * 
      * @param taxOtherExemptIndicator The taxOtherExemptIndicator to set.
      */
     public void setTaxOtherExemptIndicator(boolean taxOtherExemptIndicator) {
         this.taxOtherExemptIndicator = taxOtherExemptIndicator;
     }
 
     /**
      * Sets the taxUSAIDPerDiemIndicator attribute value.
      * 
      * @param taxUSAIDPerDiemIndicator The taxUSAIDPerDiemIndicator to set.
      */
     public void setTaxUSAIDPerDiemIndicator(boolean taxUSAIDPerDiemIndicator) {
         this.taxUSAIDPerDiemIndicator = taxUSAIDPerDiemIndicator;
     }
 
     /**
      * Sets the taxSpecialW4Amount attribute value.
      * 
      * @param taxSpecialW4Amount The taxSpecialW4Amount to set.
      */
     public void setTaxSpecialW4Amount(KualiDecimal taxSpecialW4Amount) {
         this.taxSpecialW4Amount = taxSpecialW4Amount;
     }
 
     /**
      * Gets the incomeClass attribute.
      * 
      * @return Returns the incomeClass
      */
     public TaxIncomeClassCode getIncomeClass() {
         return incomeClass;
     }
 
 
     /**
      * Sets the incomeClass attribute.
      * 
      * @param incomeClass The incomeClass to set.
      * @deprecated
      */
     @Deprecated
     public void setIncomeClass(TaxIncomeClassCode incomeClass) {
         this.incomeClass = incomeClass;
     }
 
     /**
      * Return select read-only label for income class
      * 
      * @return
      */
     public String getIncomeClassName() {
         return new TaxIncomeClassValuesFinder().getKeyLabel(incomeClassCode);
     }
 
     /**
      * Sets the incomeClassName attribute.
      * 
      * @param name The incomeClass name to set.
      */
     public void setincomeClassName(String name) {
     }
 
     /**
      * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
      */
     @SuppressWarnings("rawtypes")
     protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
         LinkedHashMap m = new LinkedHashMap();
         m.put(OLEPropertyConstants.DOCUMENT_NUMBER, this.documentNumber);
         return m;
     }
 
 }