| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ActionDefinitionContract |
|
| 1.0;1 |
| 1 | package org.kuali.rice.krms.api.repository.action; | |
| 2 | ||
| 3 | import org.kuali.rice.core.api.mo.common.Identifiable; | |
| 4 | import org.kuali.rice.core.api.mo.common.Versioned; | |
| 5 | ||
| 6 | import java.util.Map; | |
| 7 | ||
| 8 | public interface ActionDefinitionContract extends Identifiable, Versioned { | |
| 9 | ||
| 10 | /** | |
| 11 | * This is the name of the Action | |
| 12 | * | |
| 13 | * <p> | |
| 14 | * name - the name of the Action | |
| 15 | * </p> | |
| 16 | * @return the name of the Action | |
| 17 | */ | |
| 18 | public String getName(); | |
| 19 | ||
| 20 | /** | |
| 21 | * This is the namespace of the Action | |
| 22 | * | |
| 23 | * <p> | |
| 24 | * The namespace of the Action | |
| 25 | * </p> | |
| 26 | * @return the namespace of the Action | |
| 27 | */ | |
| 28 | public String getNamespace(); | |
| 29 | ||
| 30 | /** | |
| 31 | * This is the description for what the parameter is used for. This can be null or a blank string. | |
| 32 | * @return description | |
| 33 | */ | |
| 34 | public String getDescription(); | |
| 35 | ||
| 36 | /** | |
| 37 | * This is the KrmsType of the Action | |
| 38 | * | |
| 39 | * @return id for KRMS type related of the Action | |
| 40 | */ | |
| 41 | public String getTypeId(); | |
| 42 | ||
| 43 | /** | |
| 44 | * This method returns the id of the rule associated with the action | |
| 45 | * | |
| 46 | * @return id for the Rule associated with the action. | |
| 47 | */ | |
| 48 | public String getRuleId(); | |
| 49 | ||
| 50 | /** | |
| 51 | * This method returns the id of the rule associated with the action | |
| 52 | * | |
| 53 | * @return id for the Rule associated with the action. | |
| 54 | */ | |
| 55 | public Integer getSequenceNumber(); | |
| 56 | ||
| 57 | /** | |
| 58 | * This method returns a set of attributes associated with the | |
| 59 | * Action. The attributes are represented as name/value pairs. | |
| 60 | * | |
| 61 | * @return a set of ActionAttribute objects. | |
| 62 | */ | |
| 63 | public Map<String, String> getAttributes(); | |
| 64 | ||
| 65 | ||
| 66 | } |