/**
    * Copyright 2005-2015 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.rice.krad.uif.control;
  
  import java.io.Serializable;
  import java.util.HashMap;
  import java.util.Map;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.rice.kim.api.group.Group;
  import org.kuali.rice.kim.api.services.KimApiServiceLocator;
  import org.kuali.rice.krad.datadictionary.parse.BeanTag;
  import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
  import org.kuali.rice.krad.uif.field.InputField;
  import org.kuali.rice.krad.uif.util.ComponentFactory;
  import org.kuali.rice.krad.uif.util.LifecycleElement;
  import org.kuali.rice.krad.uif.widget.QuickFinder;
  
  /**
   * Represents a group control, which is a special control to handle
   * the input of a KIM Group by group name
   *
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  @BeanTag(name = "kimGroupControl", parent = "Uif-KimGroupControl")
  public class GroupControl extends TextControlBase implements FilterableLookupCriteriaControl {
      private static final long serialVersionUID = 5598459655735440981L;
  
      private String namespaceCodePropertyName;
      private String groupIdPropertyName;
  
      public GroupControl() {
          super();
      }
  
      @Override
      public void performApplyModel(Object model, LifecycleElement parent) {
          super.performApplyModel(model, parent);
  
          if (!(parent instanceof InputField)) {
              return;
          }
  
          InputField field = (InputField) parent;
  
          if (StringUtils.isNotBlank(groupIdPropertyName)) {
              field.getAdditionalHiddenPropertyNames().add(groupIdPropertyName);
          }
  
          buildGroupQuickfinder(model, field);
      }
  
      protected void buildGroupQuickfinder(Object model, InputField field) {
          QuickFinder quickFinder = field.getQuickfinder();
  
          // don't build quickfinder if explicitly turned off
          if (!field.isEnableAutoQuickfinder()) {
              return;
          }
  
          if (quickFinder == null) {
              quickFinder = ComponentFactory.getQuickFinder();
              field.setQuickfinder(quickFinder);
          }
  
          if (field.getQuickfinder() != null) {
              if (StringUtils.isBlank(field.getQuickfinder().getDataObjectClassName())) {
                  field.getQuickfinder().setDataObjectClassName("org.kuali.rice.kim.impl.group.GroupBo");
              }
  
              if (field.getQuickfinder().getFieldConversions().isEmpty()) {
                  if (StringUtils.isNotBlank(groupIdPropertyName)) {
                      field.getQuickfinder().getFieldConversions().put("id", groupIdPropertyName);
                  }
  
                  field.getQuickfinder().getFieldConversions().put("name", field.getPropertyName());
  
                  if (StringUtils.isNotBlank(namespaceCodePropertyName)) {
                      field.getQuickfinder().getFieldConversions().put("namespaceCode", namespaceCodePropertyName);
                  }
              }
  
              if (field.getQuickfinder().getLookupParameters().isEmpty()) {
                  if (StringUtils.isNotBlank(namespaceCodePropertyName)) {
                      field.getQuickfinder().getLookupParameters().put(namespaceCodePropertyName, "namespaceCode");
                  }
             }
         }
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Map<String, String> filterSearchCriteria(String propertyName, Map<String, String> searchCriteria, FilterableLookupCriteriaControlPostData postData) {
         Map<String, String> filteredSearchCriteria = new HashMap<String, String>(searchCriteria);
 
         GroupControlPostData groupControlPostData = (GroupControlPostData) postData;
 
         // check valid groupId
         // ToDo: move the groupId check and setting to the validation stage.  At that point
         //       an error should be displayed to the user that the group name and namespace is invalid.
         String groupName = searchCriteria.get(propertyName);
         String groupNamespaceCd = searchCriteria.get(groupControlPostData.getNamespaceCodePropertyName());
         if (StringUtils.isNotBlank(groupName) && StringUtils.isNotBlank(groupNamespaceCd)) {
             Group group = KimApiServiceLocator.getGroupService().getGroupByNamespaceCodeAndName(groupNamespaceCd,groupName);
             if( group == null) {
                 return null;
             } else {
                 filteredSearchCriteria.put(groupControlPostData.getGroupIdPropertyName(), group.getId());
             }
         }
 
         // filter
         filteredSearchCriteria.remove(propertyName);
         filteredSearchCriteria.remove(groupControlPostData.getNamespaceCodePropertyName());
 
         return filteredSearchCriteria;
     }
 
     /**
      * The name of the property on the parent object that holds the group namespace
      *
      * @return namespaceCodePropertyName
      */
     @BeanTagAttribute
     public String getNamespaceCodePropertyName() {
         return namespaceCodePropertyName;
     }
 
     /**
      * Setter for the name of the property on the parent object that holds the group namespace
      *
      * @param namespaceCodePropertyName
      */
     public void setNamespaceCodePropertyName(String namespaceCodePropertyName) {
         this.namespaceCodePropertyName = namespaceCodePropertyName;
     }
 
     /**
      * The name of the property on the parent object that holds the group id
      *
      * @return groupIdPropertyName
      */
     @BeanTagAttribute
     public String getGroupIdPropertyName() {
         return groupIdPropertyName;
     }
 
     /**
      * Setter for the name of the property on the parent object that holds the group id
      *
      * @param groupIdPropertyName
      */
     public void setGroupIdPropertyName(String groupIdPropertyName) {
         this.groupIdPropertyName = groupIdPropertyName;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public GroupControlPostData getPostData(String propertyName) {
         return new GroupControlPostData(propertyName, this);
     }
 
     /**
      * Holds post data for the {@link GroupControl}.
      */
     public static class GroupControlPostData implements FilterableLookupCriteriaControlPostData, Serializable {
 
         private static final long serialVersionUID = -1859777965985379673L;
 
         private String propertyName;
 
         private String namespaceCodePropertyName;
         private String groupIdPropertyName;
 
         /**
          * Constructs the post data from the property name and the {@link GroupControl}.
          *
          * @param propertyName the name of the property to filter
          * @param groupControl the control to pull data from
          */
         public GroupControlPostData(String propertyName, GroupControl groupControl) {
             this.propertyName = propertyName;
             this.namespaceCodePropertyName = groupControl.getNamespaceCodePropertyName();
             this.groupIdPropertyName = groupControl.getGroupIdPropertyName();
         }
 
         /**
          * {@inheritDoc}
          */
         @Override
         public Class<? extends FilterableLookupCriteriaControl> getControlClass() {
             return GroupControl.class;
         }
 
         /**
          * {@inheritDoc}
          */
         @Override
         public String getPropertyName() {
             return propertyName;
         }
 
         /**
          * @see GroupControl#getNamespaceCodePropertyName()
          */
         public String getNamespaceCodePropertyName() {
             return namespaceCodePropertyName;
         }
 
         /**
          * @see GroupControl#getGroupIdPropertyName()
          */
         public String getGroupIdPropertyName() {
             return groupIdPropertyName;
         }
 
     }
 
 }