| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| AgendaDefinitionContract |
|
| 1.0;1 |
| 1 | package org.kuali.rice.krms.api.repository.agenda; | |
| 2 | ||
| 3 | import java.util.Map; | |
| 4 | ||
| 5 | import org.kuali.rice.core.api.mo.common.Identifiable; | |
| 6 | import org.kuali.rice.core.api.mo.common.Versioned; | |
| 7 | import org.kuali.rice.core.api.mo.common.active.Inactivatable; | |
| 8 | ||
| 9 | public interface AgendaDefinitionContract extends Identifiable, Inactivatable, Versioned { | |
| 10 | /** | |
| 11 | * This is the name of the Agenda | |
| 12 | * | |
| 13 | * <p> | |
| 14 | * name - the name of the Agenda | |
| 15 | * </p> | |
| 16 | * @return the name of the Agenda | |
| 17 | */ | |
| 18 | public String getName(); | |
| 19 | ||
| 20 | /** | |
| 21 | * This is the namespace of the Agenda | |
| 22 | * | |
| 23 | * <p> | |
| 24 | * The namespace of the Agenda | |
| 25 | * </p> | |
| 26 | * @return the namespace of the Agenda | |
| 27 | */ | |
| 28 | public String getNamespaceCode(); | |
| 29 | ||
| 30 | /** | |
| 31 | * This is the KrmsType of the Agenda | |
| 32 | * | |
| 33 | * @return id for KRMS type related of the Agenda | |
| 34 | */ | |
| 35 | public String getTypeId(); | |
| 36 | ||
| 37 | /** | |
| 38 | * This is the ID of the Context relative to the Agenda. | |
| 39 | * | |
| 40 | * @return id for Context relative to the Agenda | |
| 41 | */ | |
| 42 | public String getContextId(); | |
| 43 | ||
| 44 | /** | |
| 45 | * This is the ID of the first AgendaItem to be executed in the Agenda. | |
| 46 | * | |
| 47 | * @return id of the first AgendaItem. | |
| 48 | */ | |
| 49 | public String getFirstItemId(); | |
| 50 | ||
| 51 | /** | |
| 52 | * This method returns a list of attributes associated with the | |
| 53 | * Agenda | |
| 54 | * | |
| 55 | * @return a list of AgendaAttribute objects. | |
| 56 | */ | |
| 57 | public Map<String, String> getAttributes(); | |
| 58 | ||
| 59 | } |