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.term;
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;
023import java.util.Set;
024
025/**
026 * <p>The contract for a {@link TermResolverDefinition} which defines a term resolver.
027 * </p>
028 * 
029 * @author Kuali Rice Team (rice.collab@kuali.org)
030 * @see TermResolverDefinition
031 * @see org.kuali.rice.krms.api.engine.TermResolver
032 */
033public interface TermResolverDefinitionContract extends Identifiable, Inactivatable, Versioned {
034
035    /**
036     * Gets the namespace for the defined term resolver. Will not be null or empty.
037     *
038     * @return the namespace
039     */
040        String getNamespace();
041
042    /**
043     * Gets the name for the defined term resolver.  The namespace and name should uniquely identify a
044     * term resolver definition.  Will not be null or empty.
045     *
046     * @return the name
047     */
048        String getName();
049
050    /**
051     * Gets the type id for the defined term resolver.  This id refers to a
052     * type which configures how the term resolver may be obtained.  May be null, but never empty.
053     *
054     * @return the type id.
055     */
056        String getTypeId();
057
058    /**
059     * Gets the term specification for the output of the defined term resolver.  Will never be null.
060     *
061     * @return the output term's specification.
062     */
063        TermSpecificationDefinitionContract getOutput();
064
065    /**
066     * Gets the term specifications for any prerequisite terms of the defined term resolver.  May be empty, but will
067     * never be null.
068     *
069     * @return any prerequisite terms.
070     */
071        Set<? extends TermSpecificationDefinitionContract> getPrerequisites();
072
073    /**
074     * Gets any attributes specified on the term resolver definition. May be empty, but never null.
075     *
076     * @return the attribute map for the term resolver definition.
077     */
078        public Map<String, String> getAttributes();
079
080    /**
081     * Gets the names of any parameters that the defined term resolver requires.  May be empty, but never null.
082     *
083     * @return the parameter names.
084     */
085        Set<String> getParameterNames();
086        
087}