Package net.pricefx.server.dto.calculation

Class ActionItemApi

Object
ActionItemApi
public class ActionItemApi extends Object
Utility class to work with Action Items in Groovy code

  • Constructor Details

    • ActionItemApi

      public ActionItemApi(FormulaEngineContext ctx, ActionItemManager actionItemManager)

  • Method Details

    • newActionItem

      public ActionItemApi.ActionItemBuilder newActionItem()
      Initiates a builder object to create a new Action Item (AI). The operation is finished with the ActionItemApi.ActionItemBuilder.create() method.

      Example: 

      
 def actionItem = api.actionItemApi().newActionItem()
   .setSummary("A brief title of the Action Item")
   .setType("__DEFAULT__")
   .setAssignedTo(userId)
   .create()
      Returns:
      a new instance of ActionItemBuilder

    • withId

      public ActionItemApi.ActionItemBuilder withId(Long actionItemId)
      Initiates an operation with an existing Action Item (specified by ID). Supported operations are update and delete.

      Example – updates the existing Action Item: 

      
 def actionItemId = 123

 def actionItem = api.actionItemApi().withId(actionItemId)
     .setSummary("An updated summary.")
     .doUpdate()
      Parameters:
      actionItemId - The id of an existing Action Item
      Returns:
      a new instance of ActionItemBuilder

    • getNewRecordsMaxLimits

      public Map<String,Integer> getNewRecordsMaxLimits()
      Returns configured limits for newly created action items.
      Returns:
      Map containing two keys:
      • limit: number of newly created action items within a given time period
      • timePeriod: timeframe in seconds within the limit is enforced. A counter of newly created action items is reset after the period elapses.