|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RuleException
Represents an exception that could be assoicate with a rule condition or rule action.
Method Summary | |
---|---|
void |
addParameter(RuleParameter ruleParameter)
Add a parameter of this rule exception. |
boolean |
appliesInScenario(int scenarioId)
Check if this rule element is valid in the specified scenario. |
java.lang.String |
getDisplayText()
Returns the text for display to the user. |
java.lang.String[] |
getParameterKeys()
Return the array of the required parameter keys for the rule. |
java.util.Set |
getParameters()
Get the parameters associated with this rule exception. |
java.lang.String |
getParamValue(java.lang.String key)
Returns the value of a parameter with the specified key. |
java.lang.String |
getType()
Get the type of exception, i.e. |
void |
setParameters(java.util.Set parameters)
Set the parameters of this rule exception. |
void |
setType(java.lang.String type)
Set the type of exception. |
void |
validate()
Checks that the rule set domain model is well formed. |
Methods inherited from interface com.elasticpath.domain.Persistence |
---|
executeBeforePersistAction, getUidPk, isPersistent, setDefaultValues, setUidPk |
Methods inherited from interface com.elasticpath.domain.EpDomain |
---|
getElasticPath, setElasticPath |
Method Detail |
---|
void addParameter(RuleParameter ruleParameter)
ruleParameter
- a RuleParameter
objectboolean appliesInScenario(int scenarioId)
scenarioId
- the Id of the scenario to check (defined in RuleScenarios)
java.lang.String getDisplayText()
java.lang.String[] getParameterKeys()
java.util.Set getParameters()
java.lang.String getParamValue(java.lang.String key)
key
- The key of the parameter to be returned
java.lang.String getType()
void setParameters(java.util.Set parameters)
parameters
- a set of RuleParameter
objectsvoid setType(java.lang.String type)
type
- the type of exceptionvoid validate() throws EpDomainException
EpDomainException
- if the structure is not correct.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |