001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kim.api.common.template;
017
018import org.kuali.rice.core.api.mo.common.GloballyUnique;
019import org.kuali.rice.core.api.mo.common.Identifiable;
020import org.kuali.rice.core.api.mo.common.Versioned;
021import org.kuali.rice.core.api.mo.common.active.Inactivatable;
022/**
023 *
024 * This is a contract for a Template. A template represents some course-grained information that is used to
025 * create a permission or responsibility which then contains more specific
026 * information in permission details or responsibility details.
027 * Eg: of a template would be Use Screen,Maintain records etc.
028 *
029 * @author Kuali Rice Team (rice.collab@kuali.org)
030 *
031 */
032
033public interface TemplateContract extends Versioned, GloballyUnique, Inactivatable, Identifiable {
034    /**
035     * The namespace code that this KIM Permission Template belongs too.
036     *
037     * @return namespaceCode
038     */
039    String getNamespaceCode();
040
041    /**
042     * The name of the KIM Permission Template.
043     *
044     * @return name
045     */
046    String getName();
047
048    /**
049     * The description of the KIM Permission Template.
050     *
051     * @return description
052     */
053        String getDescription();
054
055    /**
056     * The KIM Type ID referenced by the KIM Permission Template.
057     *
058     * @return typeId
059     */
060        String getKimTypeId();
061}