nl.gx.webmanager.cms.form
Interface Rule

public interface Rule

Describes a rule on a form model. A rule is a kind of "instance" of a rule model. It can be configured with

Author:

simon

Method Summary

Message[]	getMessages(Step step) Return all of the rule message pertaining to a step.
RuleParameter[]	getParameters(Step step) Return all of the rule parameters pertaining to a step.
RuleModel	getRuleModel() Return the rule model belonging to this rule.
Message[]	getStepMessages() Return all of the rule messages for the current step.
RuleParameter[]	getStepParameters() Return all of the rule parameters pertaining to the current step.
boolean	isEndOfFlow() Returns true for a router if the end of the flow is reached.

Method Detail

getRuleModel

RuleModel getRuleModel()

Return the rule model belonging to this rule.

Returns:

the rule model

getParameters

RuleParameter[] getParameters(Step step)

Return all of the rule parameters pertaining to a step. A rule is part of a model which describes all of the fields and steps in form. A form model can be used multiple times in the same site, each time with different values for the rule parameters. This method is used to fetch the specified values of parameters for a given, concrete instance of a step.

Parameters:

step - the step

Returns:

the array of relevant parameters.

getStepParameters

RuleParameter[] getStepParameters()

Return all of the rule parameters pertaining to the current step. The current step is determined by examining request parameters in the active HttpServletRequest object.

Returns:

array of rule parameter objects.

getMessages

Message[] getMessages(Step step)

Return all of the rule message pertaining to a step. This method returns the array of messages configured for this specific step instance.

Parameters:

step - the step

Returns:

the array of relevant messages.

getStepMessages

Message[] getStepMessages()

Return all of the rule messages for the current step. The current step is determined by examining request parameters in the active HttpServletRequest object.

Returns:

array of message objects.

isEndOfFlow

boolean isEndOfFlow()

Returns true for a router if the end of the flow is reached.

Returns:

true if the end of flow is reached.