1 /**
2 * Copyright 2005-2016 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 import java.util.Map;
23
24 /**
25 * Defines the contract for a {@link NaturalLanguageTemplate}
26 *
27 * @see NaturalLanguageTemplate
28 *
29 * @author Kuali Rice Team (rice.collab@kuali.org)
30 */
31 public interface NaturalLanguageTemplateContract extends Identifiable, Inactivatable, Versioned {
32 /**
33 * This is the Language Code of the NaturalLanguageTemplate
34 * <p>
35 * The Language Code of the NaturalLanguageTemplate
36 * </p>
37 * @return the Language Code of the NaturalLanguageTemplate
38 */
39 String getLanguageCode();
40
41 /**
42 * This is the NaturalLanguageUsageId of the NaturalLanguageTemplate
43 * <p>
44 * The NaturalLanguageUsageId of the NaturalLanguageTemplate
45 * </p>
46 * @return the NaturalLanguageUsageId of the NaturalLanguageTemplate
47 */
48 String getNaturalLanguageUsageId();
49
50 /**
51 * This is the TypeId of the NaturalLanguageTemplate
52 * <p>
53 * The TypeId of the NaturalLanguageTemplate
54 * </p>
55 * @return the TypeId of the NaturalLanguageTemplate
56 */
57 String getTypeId();
58
59 /**
60 * This is the Template of the NaturalLanguageTemplate
61 * <p>
62 * The Template of the NaturalLanguageTemplate
63 * </p>
64 * @return the Template of the NaturalLanguageTemplate
65 */
66 String getTemplate();
67
68 /**
69 * This method returns a list of custom/remote attributes associated with the
70 * agenda.
71 * <p>
72 * The attributes of the NaturalLanguageUsage
73 * </p>
74 * @return a list of custom/remote attribute of the agenda.
75 */
76 public Map<String, String> getAttributes();
77 }