| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| PropositionParameterContract |
|
| 1.0;1 |
| 1 | package org.kuali.rice.krms.api.repository.proposition; | |
| 2 | ||
| 3 | ||
| 4 | import org.kuali.rice.core.api.mo.common.Identifiable; | |
| 5 | import org.kuali.rice.core.api.mo.common.Versioned; | |
| 6 | ||
| 7 | public interface PropositionParameterContract extends Identifiable, Versioned { | |
| 8 | /** | |
| 9 | * This is the Id for the parent proposition. | |
| 10 | * | |
| 11 | * <p> | |
| 12 | * It is the Id of the parent proposition. | |
| 13 | * </p> | |
| 14 | * @return Id for parent parameter. | |
| 15 | */ | |
| 16 | public String getPropId(); | |
| 17 | ||
| 18 | ||
| 19 | /** | |
| 20 | * This is the value of the proposition parameter | |
| 21 | * | |
| 22 | * <p> | |
| 23 | * It is the value of the parameter | |
| 24 | * </p> | |
| 25 | * @return value of the parameter | |
| 26 | */ | |
| 27 | public String getValue(); | |
| 28 | ||
| 29 | /** | |
| 30 | * This is the type of the parameter. | |
| 31 | * Proposition parameters are one of the following types: | |
| 32 | * Constant Values: numbers, strings, dates, etc. | |
| 33 | * Terms: data available in the execution environment or provided by a term resolver | |
| 34 | * Functions: custom functions that resolve to a value, | |
| 35 | * or standard operators (equals, greater than, less than, ...) | |
| 36 | * | |
| 37 | * <p> | |
| 38 | * It identified the type of the parameter. | |
| 39 | * </p> | |
| 40 | * @return the parameter type code. Valid values are C, T, and F. | |
| 41 | */ | |
| 42 | public String getParameterType(); | |
| 43 | ||
| 44 | /** | |
| 45 | * This is the sequence number of the proposition parameter. | |
| 46 | * Proposition parameters are listed in Reverse Polish Notation. | |
| 47 | * The sequence number (starting with 1) identifies the position of the | |
| 48 | * parameter in the list. | |
| 49 | * | |
| 50 | * @return the sequence number of the proposition parameter | |
| 51 | */ | |
| 52 | public Integer getSequenceNumber(); | |
| 53 | } |