View Javadoc

1   /**
2    * Copyright 2005-2013 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.language;
17  
18  import org.kuali.rice.core.api.mo.common.Identifiable;
19  import org.kuali.rice.core.api.mo.common.Versioned;
20  import org.kuali.rice.core.api.mo.common.active.Inactivatable;
21  
22  /**
23   * Defines the contract for a {@link NaturalLanguageUsage}
24   *
25   * @see NaturalLanguageUsage
26   *
27   * @author Kuali Rice Team (rice.collab@kuali.org)
28   */
29  public interface NaturalLanguageUsageContract extends Identifiable, Inactivatable, Versioned {
30  
31      /**
32       * This is the Description of the NaturalLanguageUsage
33       * <p>
34       * The Description of the NaturalLanguageUsage
35       * </p>
36       * @return the Description of the NaturalLanguageUsage
37       */
38      public String getDescription();
39  
40      /**
41       * This is the name of the NaturalLanguageUsage
42       * <p>
43       * The name of the NaturalLanguageUsage
44       * </p>
45       * @return the name of the NaturalLanguageUsage
46       */
47      public String getName();
48  
49      /**
50       * This is the namespace of the NaturalLanguageUsage
51       * <p>
52       * The namespace of the NaturalLanguageUsage
53       * </p>
54       * @return the namespace of the NaturalLanguageUsage
55       */
56      public String getNamespace();
57  }