1 /**
2 * Copyright 2005-2011 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 public interface AgendaDefinitionContract extends Identifiable, Inactivatable, Versioned {
25 /**
26 * This is the name of the Agenda
27 *
28 * <p>
29 * name - the name of the Agenda
30 * </p>
31 * @return the name of the Agenda
32 */
33 public String getName();
34
35 /**
36 * This is the KrmsType of the Agenda
37 *
38 * @return id for KRMS type related of the Agenda
39 */
40 public String getTypeId();
41
42 /**
43 * This is the ID of the Context relative to the Agenda.
44 *
45 * @return id for Context relative to the Agenda
46 */
47 public String getContextId();
48
49 /**
50 * This is the ID of the first AgendaItem to be executed in the Agenda.
51 *
52 * @return id of the first AgendaItem.
53 */
54 public String getFirstItemId();
55
56 /**
57 * This method returns a list of attributes associated with the
58 * Agenda
59 *
60 * @return a list of AgendaAttribute objects.
61 */
62 public Map<String, String> getAttributes();
63
64 }