1 /**
2 * Copyright 2005-2015 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.kim.api.common.template;
17
18 import org.kuali.rice.core.api.mo.common.GloballyUnique;
19 import org.kuali.rice.core.api.mo.common.Identifiable;
20 import org.kuali.rice.core.api.mo.common.Versioned;
21 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
22 /**
23 *
24 * This is a contract for a Template. A template represents some course-grained information that is used to
25 * create a permission or responsibility which then contains more specific
26 * information in permission details or responsibility details.
27 * Eg: of a template would be Use Screen,Maintain records etc.
28 *
29 * @author Kuali Rice Team (rice.collab@kuali.org)
30 *
31 */
32
33 public interface TemplateContract extends Versioned, GloballyUnique, Inactivatable, Identifiable {
34 /**
35 * The namespace code that this KIM Permission Template belongs too.
36 *
37 * @return namespaceCode
38 */
39 String getNamespaceCode();
40
41 /**
42 * The name of the KIM Permission Template.
43 *
44 * @return name
45 */
46 String getName();
47
48 /**
49 * The description of the KIM Permission Template.
50 *
51 * @return description
52 */
53 String getDescription();
54
55 /**
56 * The KIM Type ID referenced by the KIM Permission Template.
57 *
58 * @return typeId
59 */
60 String getKimTypeId();
61 }