Class ReflectValidationRuleActionFactory

  • All Implemented Interfaces:
    ActionFactory<ValidationRuleAction>

    public class ReflectValidationRuleActionFactory
    extends Object
    implements ActionFactory<ValidationRuleAction>
    Factory implementation for validation rule actions that uses reflection to access the value of a public static field and return that as the validation rule. The public static field must be a ValidationRuleAction object.

    This factory has one configuration parameter field which is the fully qualified name for the field. Failure to access or use the class and/or field disabled the action and is reported to the log only.

    Since:
    3.2
    Author:
    nicklas
    • Constructor Detail

      • ReflectValidationRuleActionFactory

        public ReflectValidationRuleActionFactory()
    • Method Detail

      • prepareContext

        public boolean prepareContext​(InvokationContext<? super ValidationRuleAction> context)
        Description copied from interface: ActionFactory
        This method is called once for each request/use of an extension and have two purposes:
        • The factory should decide if the extension should be enabled or not. For example, the factory may check the permissions of the logged in user and determine that they are inadequate. The boolean return value determines if the extension is enabled or disabled.
        • Initialise the context with resources that the actions may need. With the BASE web-client this means that it is possible to add scripts or stylesheets that is needed by the extension. See JspContext.
        Specified by:
        prepareContext in interface ActionFactory<ValidationRuleAction>
        Parameters:
        context - The current invokation context
        Returns:
        TRUE if the extension should be enabled, FALSE if the extension should be disabled
      • getActions

        public ValidationRuleAction[] getActions​(InvokationContext<? super ValidationRuleAction> context)
        Description copied from interface: ActionFactory
        This method may be called one or several times for each request. This is decided by the extension point. If, for example, the extension point is a pure single-item extension point then this method is probably only called once. If the extension point is a per-item extension point in a list context, then this method may be called once for every item in the list. The context parameter contains all information about the context of the extension point, including the current item, if any.
        Specified by:
        getActions in interface ActionFactory<ValidationRuleAction>
        Parameters:
        context - The current invokation context
        Returns:
        An array of actions that should be added to the extension point. Returns null or an empty array if there are no actions in the current context.
      • setField

        public void setField​(String fullFieldName)