View Javadoc

1   /*
2    * Copyright 2011 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * 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 implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.student.contract.model.test.source;
17  
18  import java.util.List;
19  
20  /**
21   * Search Parameter Info
22   *
23   * A structure that holds a key value pair as a way to supply a parameter
24   * to a search.
25   *
26   * @author nwright
27   */
28  public interface SearchParam {
29  
30  
31      /**
32       * Name: Search Parameter Key
33       *
34       * The key that identifies the name of the search parameter
35       */
36      public String getKey();
37  
38      /**
39       * Name: Values
40       * 
41       * The value(s) of the search parameter
42       *
43       * Most parameters take only a single value but the list is available for
44       * operations such as "IN" that take a list of values.
45       */
46      public List<String> getValues();
47  }
48