/**
    * Copyright 2011 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/ecl1.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.student.contract.model.test.source;
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.List;
  
  import javax.xml.bind.annotation.XmlAccessType;
  import javax.xml.bind.annotation.XmlAccessorType;
  import javax.xml.bind.annotation.XmlAnyElement;
  import javax.xml.bind.annotation.XmlAttribute;
  import javax.xml.bind.annotation.XmlElement;
  import javax.xml.bind.annotation.XmlElementWrapper;
  import javax.xml.bind.annotation.XmlType;
  
  import org.kuali.student.contract.model.test.source.ModelBuilder;
  import org.kuali.student.contract.model.test.source.SearchParam;
  import org.w3c.dom.Element;
  
  /**
   * Search Parameter
   *
   * A structure that holds a key value pair to supply a value to a parameter for searching.
   *
   * @author nwright
   */
  @XmlAccessorType(XmlAccessType.FIELD)
  @XmlType(name = "SearchParamInfo", propOrder = {"key", "values", "_futureElements"})
  public class SearchParamInfo implements SearchParam, Serializable {
  
      private static final long serialVersionUID = 1L;
      @XmlAttribute
      private final String key;
      @XmlElementWrapper(name="values")
      @XmlElement(name="value")
      private final List<String> values;
      @XmlAnyElement
      private final List<Element> _futureElements;
  
      
      public SearchParamInfo() {
          this.key = null;
          this.values = null;
          this._futureElements = null;
      }
  
      public SearchParamInfo(SearchParam infc) {
          this.key = infc.getKey();
          if (this.values == null) {
              this.values = null;
          } else {
              this.values = new ArrayList(infc.getValues());
          }
          this._futureElements = null;
      }
  
      @Override
      public List<String> getValues() {
          return values;
      }
  
      @Override
      public String getKey() {
          return key;
      }
  
      public static class Builder implements ModelBuilder<SearchParamInfo>, SearchParam {
  
          private String key;
          private List<String> values;
  
          public Builder() {}
          
          public Builder(SearchParam searchInfo) {
              this.key = searchInfo.getKey();
              this.values = searchInfo.getValues();
          }
          
          public SearchParamInfo build () {
              return new SearchParamInfo (this);
          }
          
          public String getKey() {
             return key;
         }
 
         public void setKey(String key) {
             this.key = key;
         }
 
         public List<String> getValues() {
             return values;
         }
 
         public void setValues(List<String> values) {
             this.values = values;
         }
 
         /**
          * Convenience method for setting a single value
          * Actually stores it as a list with one value.
          * @param value
          */
         public Builder value(String value) {
             this.values = Arrays.asList(value);
             return this;
         }
     }
 }