Package net.pricefx.formulaengine.scripting.portlets

Interface ResultMatrix.BackEndAction

All Superinterfaces:
Serializable
All Known Subinterfaces:
ResultMatrix.BackEndAction
All Known Implementing Classes:
ResultMatrix.ResultMatrixBackEndAction
Enclosing interface:
ResultMatrix
public static interface ResultMatrix.BackEndAction extends Serializable

Object representing a button that handles multi-row actions.

The action will be handled by a dedicated logic, which receives an InputMatrix parameter named after the provided id String and featuring the row values of a subset of the columns.

Note: This is available in Unity UI only. No backporting planned for the Classic UI.

See ResultMatrix.rowSelectionBackEndAction(String) to find out how to create an instance of ResultMatrixBackEndAction.

Since:
7.0 Bijou

  • Method Details

    • withLogicName

      ResultMatrix.BackEndAction withLogicName(String name)
      Specifies the logic that is executed as a BackEndAction logic within ResultMatrix.rowSelectionBackEndAction(String).
      Note: This method refers to the generic nature of the logic.
      Parameters:
      name - the name of the logic to be executed
      Since:
      7.0 Bijou
      See Also:

    • withTargetDate

      ResultMatrix.BackEndAction withTargetDate(Date date)
      Parameters:
      date - optional targetDate in case there are multiple active versions with the same name
      Since:
      7.0 Bijou

    • withColumns

      ResultMatrix.BackEndAction withColumns(String... names)
      Parameters:
      names - list of column names that will be passed as InputMatrix to the logic (replaces any previously set column names)
      Since:
      7.0 Bijou

    • addColumn

      ResultMatrix.BackEndAction addColumn(String name)
      Parameters:
      name - name to add in the list of columns that will be passed as InputMatrix to the logic
      Since:
      7.0 Bijou

    • addFormulaInput

      ResultMatrix.BackEndAction addFormulaInput(String name, Object value)
      Parameters:
      name - name of the input parameter that will be passed to the logic
      value - value of the input parameter that will be passed to the logic (keep in mind that this value makes a round trip to the front end in JSON format)
      Since:
      7.0 Bijou

    • withButtonLabel

      ResultMatrix.BackEndAction withButtonLabel(String label)
      Parameters:
      label - the label of the action button
      Since:
      7.0 Bijou

    • withButtonTooltip

      ResultMatrix.BackEndAction withButtonTooltip(String tooltip)
      Parameters:
      tooltip - optional hover message for additional info about the action
      Since:
      7.0 Bijou

    • withOptions

      ResultMatrix.BackEndAction withOptions(String paramName, Map<String,Object> paramOptions)
      Parameters:
      paramName - optional header type that can be listed in the button dropdown menu
      paramOptions - optional header type that can be listed in the button dropdown menu
      Since:
      11.1 Paper Plane

    • withSuccessMessage

      ResultMatrix.BackEndAction withSuccessMessage(String text)
      Parameters:
      text - message to display in case of success of the backend call
      Since:
      7.0 Bijou

    • withFailureMessage

      ResultMatrix.BackEndAction withFailureMessage(String text)
      Parameters:
      text - message to display in case of failure of the backend call
      Since:
      7.0 Bijou