View Javadoc

1   /*
2    * Copyright 2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the
5    * "License"); you may not use this file except in compliance with the
6    * License.  You may obtain a copy of the License at
7    *
8    * 	http://www.osedu.org/licenses/ECL-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13   * implied.  See the License for the specific language governing
14   * permissions and limitations under the License.
15   */
16  
17  package org.kuali.student.r2.common.infc;
18  
19  import java.util.List;
20  
21  /**
22   * Search Parameter Info
23   *
24   * A structure that holds a key value pair as a way to supply a
25   * parameter to a search.
26   *
27   * @author nwright
28   */
29  
30  @Deprecated
31  public interface SearchParam {
32  
33      /**
34       * The key that identifies the name of the search parameter
35       *
36       * @name Key
37       */
38      public String getKey();
39  
40      /**
41       * The value(s) of the search parameter.
42       *
43       * Most parameters take only a single value but the list is
44       * available for operations such as "IN" that take a list of
45       * values.
46       *
47       * @ame Values
48       */
49      public List<String> getValues();
50  }
51