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.agenda;
017
018import java.util.Map;
019
020import org.kuali.rice.core.api.mo.common.Identifiable;
021import org.kuali.rice.core.api.mo.common.Versioned;
022import org.kuali.rice.core.api.mo.common.active.Inactivatable;
023
024/**
025 * Agenda Definition Contract
026 *
027 * @see AgendaDefinition
028 */
029public interface AgendaDefinitionContract extends Identifiable, Inactivatable, Versioned {
030        /**
031         * Returns the name of the Agenda.
032         *
033         * @return the name of the Agenda
034         */
035        public String getName();
036
037        /**
038         * Returns the KRMS type id of the Agenda.
039         *
040         * @return id for KRMS type related of the agenda
041         */
042        public String getTypeId();
043        
044        /**
045         * Returns the context id of the Agenda.
046         *
047         * @return id for context relative to the agenda
048         */     
049        public String getContextId();
050        
051        /**
052         * Returns the fist agenda item id to be executed in the Agenda.
053     * (Also known as the root of the agenda item / rules tree.)
054         *
055         * @return id of the first agenda item id of the agenda.
056         */     
057        public String getFirstItemId();
058        
059        /**
060         * This method returns a list of custom/remote attributes associated with the
061         * agenda.
062         * 
063         * @return a list of custom/remote attribute of the agenda.
064         */
065        public Map<String, String> getAttributes();
066        
067}