| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| AgendaItemContract |
|
| 1.0;1 |
| 1 | package org.kuali.rice.krms.api.repository.agenda; | |
| 2 | ||
| 3 | import org.kuali.rice.core.api.mo.common.Identifiable; | |
| 4 | import org.kuali.rice.core.api.mo.common.Versioned; | |
| 5 | import org.kuali.rice.krms.api.repository.rule.RuleDefinitionContract; | |
| 6 | ||
| 7 | public interface AgendaItemContract extends Identifiable, Versioned { | |
| 8 | ||
| 9 | /** | |
| 10 | * This is the agenda ID for the Agenda associated with this Agenda Item | |
| 11 | * | |
| 12 | * <p> | |
| 13 | * It is the agenda ID for the Agenda object associated with this Agenda Item. | |
| 14 | * </p> | |
| 15 | * @return ID for AgendaItem | |
| 16 | */ | |
| 17 | public String getAgendaId(); | |
| 18 | ||
| 19 | /** | |
| 20 | * This is ID of the Rule associated with this AgendaItem. | |
| 21 | * <p> | |
| 22 | * Each AgendaItem has either a Rule or a SubAgenda associated with it, but not both. | |
| 23 | * <p> | |
| 24 | * @return ID of the Rule associated with the AgendaItem | |
| 25 | */ | |
| 26 | public String getRuleId(); | |
| 27 | ||
| 28 | /** | |
| 29 | * This is ID of the SubAgenda associated with this AgendaItem. | |
| 30 | * <p> | |
| 31 | * Each AgendaItem has either a Rule or a SubAgenda associated with it, but not both. | |
| 32 | * <p> | |
| 33 | * @return ID of the SubAgenda associated with the AgendaItem | |
| 34 | */ | |
| 35 | public String getSubAgendaId(); | |
| 36 | ||
| 37 | /** | |
| 38 | * This is ID of the next AgendaItem to be executed if the Rule associated | |
| 39 | * AgendaItem evaluates to true. | |
| 40 | * @return ID of the next AgendaItem | |
| 41 | */ | |
| 42 | public String getWhenTrueId(); | |
| 43 | ||
| 44 | /** | |
| 45 | * This is ID of the next AgendaItem to be executed if the Rule associated | |
| 46 | * AgendaItem evaluates to false. | |
| 47 | * @return ID of the next AgendaItem | |
| 48 | */ | |
| 49 | public String getWhenFalseId(); | |
| 50 | ||
| 51 | /** | |
| 52 | * This is ID of the next AgendaItem to be executed after following any | |
| 53 | * defined true or false actions. | |
| 54 | * @return ID of the next AgendaItem | |
| 55 | */ | |
| 56 | public String getAlwaysId(); | |
| 57 | ||
| 58 | /** | |
| 59 | * | |
| 60 | * This method returns the Rule associated with this AgendaItem. | |
| 61 | * | |
| 62 | * @return an immutable representation of the Rule | |
| 63 | */ | |
| 64 | public RuleDefinitionContract getRule(); | |
| 65 | ||
| 66 | /** | |
| 67 | * | |
| 68 | * This method returns the SubAgenda associated with this AgendaItem. | |
| 69 | * | |
| 70 | * @return an immutable representation of the SubAgenda | |
| 71 | */ | |
| 72 | public AgendaDefinitionContract getSubAgenda(); | |
| 73 | ||
| 74 | /** | |
| 75 | * This method returns the next AgendaItem to be executed if the | |
| 76 | * Rule associated with this AgendaItem evaluates to true. | |
| 77 | * @return an immutable representation of the next AgendaItem | |
| 78 | */ | |
| 79 | public AgendaItemContract getWhenTrue(); | |
| 80 | ||
| 81 | /** | |
| 82 | * This method returns the next AgendaItem to be executed if the | |
| 83 | * Rule associated with this AgendaItem evaluates to false. | |
| 84 | * @return an immutable representation of the next AgendaItem | |
| 85 | */ | |
| 86 | public AgendaItemContract getWhenFalse(); | |
| 87 | ||
| 88 | /** | |
| 89 | * This is ID of the next AgendaItem to be executed after following any | |
| 90 | * defined true or false actions. | |
| 91 | * @return an immutable representation of the next AgendaItem | |
| 92 | */ | |
| 93 | public AgendaItemContract getAlways(); | |
| 94 | ||
| 95 | } |