/*
    * 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.module.cg.businessobject;
  
  import java.util.LinkedHashMap;
  
  import org.kuali.ole.integration.cg.ContractsAndGrantsAgency;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.rice.core.api.mo.common.active.MutableInactivatable;
  import org.kuali.rice.core.api.util.type.KualiDecimal;
  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
  
  /**
   * This class defines an agency as it is used and referenced within the Contracts and Grants portion of a college or university
   * financial system.
   */
  public class Agency extends PersistableBusinessObjectBase implements ContractsAndGrantsAgency, MutableInactivatable {
  
      private String agencyNumber;
      private String reportingName;
      private String fullName;
      private String agencyTypeCode;
      private String reportsToAgencyNumber;
      private KualiDecimal indirectAmount;
      private boolean inStateIndicator;
      private Agency reportsToAgency;
      private AgencyType agencyType;
      private boolean active;
  
      public static final String CACHE_NAME = OLEConstants.APPLICATION_NAMESPACE_CODE + "/" + "Agency";
  
      /**
       * Gets the agencyTypeCode attribute.
       *
       * @return Returns the agencyTypeCode.
       */
      public String getAgencyTypeCode() {
          return agencyTypeCode;
      }
  
      /**
       * Sets the agencyTypeCode attribute value.
       *
       * @param agencyTypeCode The agencyTypeCode to set.
       */
      public void setAgencyTypeCode(String agencyTypeCode) {
          this.agencyTypeCode = agencyTypeCode;
      }
  
      /**
       * Gets the reportsToAgencyNumber attribute.
       *
       * @return Returns the reportsToAgencyNumber.
       */
      public String getReportsToAgencyNumber() {
          return reportsToAgencyNumber;
      }
  
      /**
       * Sets the reportsToAgencyNumber attribute value.
       *
       * @param reportsToAgencyNumber The reportsToAgencyNumber to set.
       */
      public void setReportsToAgencyNumber(String reportsToAgencyNumber) {
          this.reportsToAgencyNumber = reportsToAgencyNumber;
      }
  
      /**
       * Default no-arg constructor.
       */
      public Agency() {
  
      }
  
      /**
       * Gets the agencyNumber attribute.
       *
       * @return Returns the agencyNumber
       */
      @Override
      public String getAgencyNumber() {
          return agencyNumber;
      }
  
      /**
      * Sets the agencyNumber attribute.
      *
      * @param agencyNumber The agencyNumber to set.
      */
     public void setAgencyNumber(String agencyNumber) {
         this.agencyNumber = agencyNumber;
     }
 
     /**
      * Gets the reportingName attribute.
      *
      * @return Returns the reportingName
      */
     public String getReportingName() {
         return reportingName;
     }
 
     /**
      * Sets the reportingName attribute.
      *
      * @param reportingName The reportingName to set.
      */
     public void setReportingName(String reportingName) {
         this.reportingName = reportingName;
     }
 
     /**
      * Gets the fullName attribute.
      *
      * @return Returns the fullName
      */
     public String getFullName() {
         return fullName;
     }
 
     /**
      * Sets the fullName attribute.
      *
      * @param fullName The fullName to set.
      */
     public void setFullName(String fullName) {
         this.fullName = fullName;
     }
 
     /**
      * Gets the indirectAmount attribute.
      *
      * @return Returns the indirectAmount
      */
     public KualiDecimal getIndirectAmount() {
         return indirectAmount;
     }
 
     /**
      * Sets the indirectAmount attribute.
      *
      * @param indirectAmount The indirectAmount to set.
      */
     public void setIndirectAmount(KualiDecimal indirectAmount) {
         this.indirectAmount = indirectAmount;
     }
 
     /**
      * Gets the inStateIndicator attribute.
      *
      * @return Returns the inStateIndicator
      */
     public boolean isInStateIndicator() {
         return inStateIndicator;
     }
 
     /**
      * Sets the inStateIndicator attribute.
      *
      * @param inStateIndicator The inStateIndicator to set.
      */
     public void setInStateIndicator(boolean inStateIndicator) {
         this.inStateIndicator = inStateIndicator;
     }
 
     /**
      * Gets the reportsToAgency attribute.
      *
      * @return Returns the reportsToAgency
      */
     public Agency getReportsToAgency() {
         return reportsToAgency;
     }
 
     /**
      * Sets the reportsToAgency attribute.
      *
      * @param reportsToAgencyNumber The reportsToAgency to set.
      * @deprecated
      * @todo Why is this deprecated?
      */
     @Deprecated
     public void setReportsToAgency(Agency reportsToAgencyNumber) {
         this.reportsToAgency = reportsToAgencyNumber;
     }
 
     /**
      * Gets the agencyType attribute.
      *
      * @return Returns the agencyType
      */
     public AgencyType getAgencyType() {
         return agencyType;
     }
 
     /**
      * Sets the agencyType attribute.
      *
      * @param agencyType The agencyType to set.
      * @deprecated
      * @todo Why is this deprecated?
      */
     @Deprecated
     public void setAgencyType(AgencyType agencyType) {
         this.agencyType = agencyType;
     }
 
     /**
      * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
      */
     protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
         LinkedHashMap m = new LinkedHashMap();
 
         m.put("agencyNumber", getAgencyNumber());
         return m;
     }
 
     /**
      * This method compares the passed in agency object against this agency object to check for equality. Equality is defined by if
      * the agency passed in has the same agency number as the agency being compared to.
      *
      * @param agency The agency object to be compared.
      * @return True if the agency passed in is determined to be equal, false otherwise.
      */
     public boolean equals(Agency agency) {
         return this.agencyNumber.equals(agency.getAgencyNumber());
     }
 
     /**
      * Gets the active attribute.
      * @return Returns the active.
      */
     @Override
     public boolean isActive() {
         return active;
     }
 
     /**
      * Sets the active attribute value.
      * @param active The active to set.
      */
     @Override
     public void setActive(boolean active) {
         this.active = active;
     }
 
 }