Package ch.tocco.nice2.model.form.impl.form2.components

Class ActionImpl

java.lang.Object
ch.tocco.nice2.model.form.impl.form2.components.AbstractComponent
ch.tocco.nice2.model.form.impl.form2.components.AbstractCompositeComponent
ch.tocco.nice2.model.form.impl.form2.components.AbstractAction
ch.tocco.nice2.model.form.impl.form2.components.ActionImpl
All Implemented Interfaces:
Action, BaseAction, Component, CompositeComponent, Cloneable
public class ActionImpl extends AbstractAction implements Action

  • Constructor Details

    • ActionImpl

      public ActionImpl()

  • Method Details

    • getEndpoint

      @Nullable public @Nullable String getEndpoint()
      Description copied from interface: Action
      This REST endpoint will be called by the action. Must be defined if the action type is equal BaseAction.ActionType.SIMPLE. It can also be set on BaseAction.ActionType.CUSTOM for pre-action logic.
      Specified by:
      getEndpoint in interface Action

    • setEndpoint

      public void setEndpoint(String endpoint)

    • getAppId

      @Nullable public @Nullable String getAppId()
      Description copied from interface: Action
      The app with this id will be called by the action. Must only be defined if the action type is equal BaseAction.ActionType.CUSTOM
      Specified by:
      getAppId in interface Action

    • setAppId

      public void setAppId(String appId)

    • getPath

      @Nullable public @Nullable String getPath()
      Description copied from interface: Action
      The legacy action with this path will be called. Must only be defined if the action type is equal BaseAction.ActionType.LEGACY
      Specified by:
      getPath in interface Action

    • setPath

      public void setPath(String path)

    • setUseLabel

      public void setUseLabel(UseLabel useLabel)

    • getUseLabel

      public UseLabel getUseLabel()
      Description copied from interface: Action
      used to determine whether the label should be displayed
      Specified by:
      getUseLabel in interface Action

    • setDmsEntityModel

      public void setDmsEntityModel(String dmsEntityModel)

    • getDmsEntityModel

      public String getDmsEntityModel()
      Description copied from interface: Action
      used to determine on which dms items to display an action
      Specified by:
      getDmsEntityModel in interface Action

    • setButtonType

      public void setButtonType(ButtonType buttonType)

    • getButtonType

      public ButtonType getButtonType()
      Description copied from interface: Action
      used to decide the look of an action
      Specified by:
      getButtonType in interface Action

    • setButtonStyle

      public void setButtonStyle(BaseAction.ButtonStyle buttonStyle)

    • getButtonStyle

      public BaseAction.ButtonStyle getButtonStyle()
      Description copied from interface: Action
      used to decide the look of an action button
      Specified by:
      getButtonStyle in interface Action

    • getProperties

      public Map<String,Object> getProperties()
      Description copied from interface: Action
      The properties for the action. The value can either be of type string, boolean or number.
      Specified by:
      getProperties in interface Action

    • addProperty

      public void addProperty(String name, Object value)

    • validate

      public void validate() throws ModelBuildException
      Description copied from interface: Component
      Will be called when the form has been built completely. Can be used to validate values (and throw ModelBuildException) or the fill in default value.
      Specified by:
      validate in interface Component
      Overrides:
      validate in class AbstractCompositeComponent
      Throws:
      ModelBuildException

    • setOnlyShowOnEmptyColumn

      public void setOnlyShowOnEmptyColumn(boolean onlyShowOnEmptyColumn)

    • isOnlyShowOnEmptyColumn

      public boolean isOnlyShowOnEmptyColumn()
      Specified by:
      isOnlyShowOnEmptyColumn in interface Action

    • setConditionName

      public void setConditionName(String conditionName)

    • getConditionName

      public String getConditionName()
      Description copied from interface: Action
      Name of the action condition used to decide if action is shown
      Specified by:
      getConditionName in interface Action

    • isPlaceholder

      public boolean isPlaceholder()
      Description copied from interface: Action
      Returns true if an action is only a placeholder. A placeholder is only available during using FormInterceptors. The last FormInterceptor RemovePlaceholderInterceptor removes such placeholders. Placeholders are required to define the sorting (e.g. "after:delete"). Else during sorting sometimes errors are logged.
      Specified by:
      isPlaceholder in interface Action

    • setPlaceholder

      public void setPlaceholder(boolean isPlaceholder)