All Superinterfaces:
BaseAction, Cloneable, Component, CompositeComponent
All Known Implementing Classes:
ActionImpl

public interface Action extends BaseAction
  • Method Details Link icon

    • getEndpoint Link icon

      @Nullable @Nullable String getEndpoint()
      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.
    • getAppId Link icon

      @Nullable @Nullable String getAppId()
      The app with this id will be called by the action. Must only be defined if the action type is equal BaseAction.ActionType.CUSTOM
    • getPath Link icon

      @Nullable @Nullable String getPath()
      The legacy action with this path will be called. Must only be defined if the action type is equal BaseAction.ActionType.LEGACY
    • getUseLabel Link icon

      UseLabel getUseLabel()
      used to determine whether the label should be displayed
    • getDmsEntityModel Link icon

      String getDmsEntityModel()
      used to determine on which dms items to display an action
    • getButtonType Link icon

      ButtonType getButtonType()
      used to decide the look of an action
    • getButtonStyle Link icon

      BaseAction.ButtonStyle getButtonStyle()
      used to decide the look of an action button
    • getProperties Link icon

      Map<String,Object> getProperties()
      The properties for the action. The value can either be of type string, boolean or number.
    • isOnlyShowOnEmptyColumn Link icon

      boolean isOnlyShowOnEmptyColumn()
    • getConditionName Link icon

      String getConditionName()
      Name of the action condition used to decide if action is shown
    • isPlaceholder Link icon

      boolean isPlaceholder()
      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.