Package mc.core.domain.base.aspect

Interface IStateTransitionHandler

public interface IStateTransitionHandler

  • Method Details

    • executePre

      boolean executePre(IStateManaged object, StateTransitionType stateTransitionType, Locale locale) throws ApplicationException
      this method is called before the transition
      Returns:
      returns false if the transition should not be done
      Throws:
      ApplicationException

    • executePost

      void executePost(IStateManaged object, StateTransitionType stateTransitionType, Locale locale) throws ApplicationException
      this method is called after
      Throws:
      ApplicationException

    • initParameterMap

      default void initParameterMap(mc.core.system.util.map.ObjectMap parameter)
      this method is called prior to executePre(IStateManaged, StateTransitionType, Locale) to init parameter from configuration
      Parameters:
      parameter - key/value parameter set in configuration or empty map. never null
      Since:
      8.1

    • getFieldHandlerDescription

      default String getFieldHandlerDescription()
      A field handler can display a plaintext name in the GUI. This can be defined by a resource, but by default it is the simple name of the class
      Returns:
      String to display in the UI when presenting the field handler to the user (e.g. in a list of available field handlers)

    • getRequiredParametersAndValues

      default mc.core.system.util.map.ObjectMap getRequiredParametersAndValues()
      A field handler can include optional parameters which are String key / value pairs. If a field handler requires these parameters, it can include a list of the required parameters as a Map<String, String> by overriding this default implementation.
      Returns:
      Map of Key / Value as Strings