001/**
002 * Copyright 2005-2016 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.krms.api.repository.language;
017
018import org.kuali.rice.core.api.mo.common.Identifiable;
019import org.kuali.rice.core.api.mo.common.Versioned;
020import org.kuali.rice.core.api.mo.common.active.Inactivatable;
021
022import java.util.Map;
023
024/**
025 * Defines the contract for a {@link NaturalLanguageTemplate}
026 *
027 * @see NaturalLanguageTemplate
028 *
029 * @author Kuali Rice Team (rice.collab@kuali.org)
030 */
031public interface NaturalLanguageTemplateContract extends Identifiable, Inactivatable, Versioned {
032    /**
033     * This is the Language Code of the NaturalLanguageTemplate
034     * <p>
035     * The Language Code of the NaturalLanguageTemplate
036     * </p>
037     * @return the Language Code of the NaturalLanguageTemplate
038     */
039    String getLanguageCode();
040
041    /**
042     * This is the NaturalLanguageUsageId of the NaturalLanguageTemplate
043     * <p>
044     * The NaturalLanguageUsageId of the NaturalLanguageTemplate
045     * </p>
046     * @return the NaturalLanguageUsageId of the NaturalLanguageTemplate
047     */
048    String getNaturalLanguageUsageId();
049
050    /**
051     * This is the TypeId of the NaturalLanguageTemplate
052     * <p>
053     * The TypeId of the NaturalLanguageTemplate
054     * </p>
055     * @return the TypeId of the NaturalLanguageTemplate
056     */
057    String getTypeId();
058
059    /**
060     * This is the Template of the NaturalLanguageTemplate
061     * <p>
062     * The Template of the NaturalLanguageTemplate
063     * </p>
064     * @return the Template of the NaturalLanguageTemplate
065     */
066    String getTemplate();
067
068    /**
069     * This method returns a list of custom/remote attributes associated with the
070     * agenda.
071     * <p>
072     * The attributes of the NaturalLanguageUsage
073     * </p>
074     * @return a list of custom/remote attribute of the agenda.
075     */
076    public Map<String, String> getAttributes();
077}