1 /**
2 * Copyright 2005-2013 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.krms.api.repository.agenda;
17
18 import java.util.Map;
19
20 import org.kuali.rice.core.api.mo.common.Identifiable;
21 import org.kuali.rice.core.api.mo.common.Versioned;
22 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
23
24 /**
25 * Agenda Definition Contract
26 *
27 * @see AgendaDefinition
28 */
29 public interface AgendaDefinitionContract extends Identifiable, Inactivatable, Versioned {
30 /**
31 * Returns the name of the Agenda.
32 *
33 * @return the name of the Agenda
34 */
35 public String getName();
36
37 /**
38 * Returns the KRMS type id of the Agenda.
39 *
40 * @return id for KRMS type related of the agenda
41 */
42 public String getTypeId();
43
44 /**
45 * Returns the context id of the Agenda.
46 *
47 * @return id for context relative to the agenda
48 */
49 public String getContextId();
50
51 /**
52 * Returns the fist agenda item id to be executed in the Agenda.
53 * (Also known as the root of the agenda item / rules tree.)
54 *
55 * @return id of the first agenda item id of the agenda.
56 */
57 public String getFirstItemId();
58
59 /**
60 * This method returns a list of custom/remote attributes associated with the
61 * agenda.
62 *
63 * @return a list of custom/remote attribute of the agenda.
64 */
65 public Map<String, String> getAttributes();
66
67 }