1 /*
2 * Copyright 2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 1.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.opensource.org/licenses/ecl1.php
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.rice.core.api.criteria;
17
18 /**
19 * A wrapper for values that are used on a {@link Criteria}. This wrapper
20 * allows for single parameterized type for all criteria values and
21 * aids primarily in mapping these values to a message format for use on a
22 * remotable service (i.e. with marhaling to XML using JAXB)
23 *
24 * <p>Has a single method {@link #getValue()} which simply returns the
25 * wrapped value.
26 *
27 * @param <T> the type of the value stored by this CriteriaValue
28 *
29 * @author Kuali Rice Team (rice.collab@kuali.org)
30 *
31 */
32 public interface CriteriaValue<T> {
33
34 /**
35 * Returns the stored value. This value should never be null.
36 *
37 * @return the stored value, should never be null
38 */
39 T getValue();
40
41 }