View Javadoc

1   /**
2    * Copyright 2005-2014 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.opensource.org/licenses/ecl2.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.krms.api.repository.term;
17  
18  import org.kuali.rice.core.api.mo.common.Identifiable;
19  import org.kuali.rice.core.api.mo.common.Versioned;
20  
21  /**
22   * <p>The contract for a {@link TermParameterDefinition} which defines a term parameter.  This is simply
23   * a name and a value that is associated with a term by an identifier.
24   * </p>
25   * 
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   * @see TermParameterDefinition
28   */
29  public interface TermParameterDefinitionContract extends Identifiable, Versioned {
30  
31      /**
32       * Gets the identifier for the term that this parameter belongs to.  May be null, must not be empty.
33       *
34       * @return the term identifier
35       */
36  	String getTermId();
37  
38      /**
39       * Gets the name of this parameter.  Must not be null or empty.
40       *
41       * @return the name of this parameter
42       */
43  	String getName();
44  
45      /**
46       * Gets the value of this parameter.  May be null.
47       *
48       * @return the value of this parameter
49       */
50  	String getValue();
51  
52  }