| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ActionContract |
|
| 1.0;1 |
| 1 | package org.kuali.rice.krms.api.repository; | |
| 2 | ||
| 3 | import java.util.List; | |
| 4 | ||
| 5 | public interface ActionContract { | |
| 6 | /** | |
| 7 | * This is the ID for the Action | |
| 8 | * | |
| 9 | * <p> | |
| 10 | * It is a ID of a Action | |
| 11 | * </p> | |
| 12 | * @return ID for Action | |
| 13 | */ | |
| 14 | public String getActionId(); | |
| 15 | ||
| 16 | /** | |
| 17 | * This is the name of the Action | |
| 18 | * | |
| 19 | * <p> | |
| 20 | * name - the name of the Action | |
| 21 | * </p> | |
| 22 | * @return the name of the Action | |
| 23 | */ | |
| 24 | public String getName(); | |
| 25 | ||
| 26 | /** | |
| 27 | * This is the namespace of the Action | |
| 28 | * | |
| 29 | * <p> | |
| 30 | * The namespace of the Action | |
| 31 | * </p> | |
| 32 | * @return the namespace of the Action | |
| 33 | */ | |
| 34 | public String getNamespace(); | |
| 35 | ||
| 36 | /** | |
| 37 | * This is the description for what the parameter is used for. This can be null or a blank string. | |
| 38 | * @return description | |
| 39 | */ | |
| 40 | public String getDescription(); | |
| 41 | ||
| 42 | /** | |
| 43 | * This is the KrmsType of the Action | |
| 44 | * | |
| 45 | * @return id for KRMS type related of the Action | |
| 46 | */ | |
| 47 | public String getTypeId(); | |
| 48 | /** | |
| 49 | * This method returns a list of attributes associated with the | |
| 50 | * Action | |
| 51 | * | |
| 52 | * @return a list of ActionAttribute objects. | |
| 53 | */ | |
| 54 | public List<? extends ActionAttributeContract> getAttributes(); | |
| 55 | ||
| 56 | ||
| 57 | } |