Package org.alfresco.repo.action

Class ParameterizedItemAbstractBase

java.lang.Object
org.alfresco.repo.action.CommonResourceAbstractBase
org.alfresco.repo.action.ParameterizedItemAbstractBase
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware
Direct Known Subclasses:
ActionConditionEvaluatorAbstractBase, ActionExecuterAbstractBase
public abstract class ParameterizedItemAbstractBase extends CommonResourceAbstractBase
Rule item abstract base.

Helper base class used by the action exector and condition evaluator implementations.

Author:
Roy Wetherall

  • Field Details

    • DISPLAY_LABEL

      protected static final String DISPLAY_LABEL
      See Also:

    • adhocPropertiesAllowed

      protected boolean adhocPropertiesAllowed
      Indicates whether or not ad-hoc properties can be provided. Default so false.

    • runtimeActionService

      protected RuntimeActionService runtimeActionService
      Action service

  • Constructor Details

    • ParameterizedItemAbstractBase

      public ParameterizedItemAbstractBase()

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      Return a short title and description string

    • setLocales

      public void setLocales(Set<Locale> locales)

    • getParameterDefintions

      protected List<ParameterDefinition> getParameterDefintions()
      Gets a list containing the parameter definitions for this rule item.
      Returns:
      the list of parameter definitions

    • addParameterDefinitions

      protected abstract void addParameterDefinitions(List<ParameterDefinition> paramList)
      Adds the parameter definitions to the list
      Parameters:
      paramList - the parameter definitions list

    • getLocalizedParameterDefinitions

      protected Map<Locale,List<ParameterDefinition>> getLocalizedParameterDefinitions()
      Gets a list containing the parameter definitions for this rule item.
      Returns:
      the map of parameter definitions with locales

    • setRuntimeActionService

      public void setRuntimeActionService(RuntimeActionService runtimeActionService)
      Sets the action service
      Parameters:
      runtimeActionService - the action service

    • getTitleKey

      protected String getTitleKey()
      Gets the title I18N key
      Returns:
      the title key

    • getDescriptionKey

      protected String getDescriptionKey()
      Gets the description I18N key
      Returns:
      the description key

    • setAdhocPropertiesAllowed

      public void setAdhocPropertiesAllowed(boolean allowed)
      Setter for Spring injection of adhocPropertiesAllowed property
      Parameters:
      allowed - boolean

    • getAdhocPropertiesAllowed

      protected boolean getAdhocPropertiesAllowed()
      Indicates whether adhoc property definitions are allowed or not
      Returns:
      true if they are, by default false

    • getParamDisplayLabel

      protected String getParamDisplayLabel(String paramName)
      Gets the parameter definition display label from the properties file.
      Parameters:
      paramName - the name of the parameter
      Returns:
      the diaplay label of the parameter

    • getParamDisplayLabel

      protected String getParamDisplayLabel(String paramName, Locale locale)
      Gets the parameter definition display label from the properties file.
      Parameters:
      paramName - the name of the parameter
      locale - the name of the locale
      Returns:
      the display label of the parameter

    • checkMandatoryProperties

      protected void checkMandatoryProperties(ParameterizedItem ruleItem, ParameterizedItemDefinition ruleItemDefinition)
      Checked whether all the mandatory parameters for the rule item have been assigned.
      Parameters:
      ruleItem - the rule item
      ruleItemDefinition - the rule item definition