Class TriggerInfo

java.lang.Object
com.inet.taskplanner.server.api.common.AbstractInfo
com.inet.taskplanner.server.api.trigger.TriggerInfo

public final class TriggerInfo extends AbstractInfo
Information about the GUI representation of a trigger.
Since:
taskplanner 3.0
See Also:
  • Constructor Details

    • TriggerInfo

      public TriggerInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey, List<Field> fields, List<String> placeholderKeys)
      Creates a new info instance.
      Parameters:
      extensionName - the unique extensionName, there must be a TriggerFactory for this extensionName.
      displayName - localized name of the trigger to show
      description - localized description of the trigger to show
      iconURL - url to the icon of the trigger
      helpKey - key of the helppage to open for this trigger
      fields - List of fields which represents the editable properties of the trigger
      placeholderKeys - a list of placeholders (without placeholder brackets) that are supported by this trigger.
      Throws:
      IllegalArgumentException - if extensionName, displayName, description, or fields are null
      Since:
      taskplanner 20.4
    • TriggerInfo

      public TriggerInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey, List<Field> fields)
      Creates a new info instance.
      Parameters:
      extensionName - the unique extensionName, there must be a TriggerFactory for this extensionName.
      displayName - localized name of the trigger to show
      description - localized description of the trigger to show
      iconURL - url to the icon of the trigger
      helpKey - key of the helppage to open for this trigger
      fields - List of fields which represents the editable properties of the trigger
      Throws:
      IllegalArgumentException - if extensionName, displayName, description, or fields are null
      Since:
      taskplanner 3.0
    • TriggerInfo

      public TriggerInfo(String extensionName, String displayName, String description, URL iconURL, String helpKey)
      Creates a new info instance.
      Parameters:
      extensionName - the unique extensionName, there must be a TriggerFactory for this extensionName.
      displayName - localized name of the trigger to show
      description - localized description of the trigger to show
      iconURL - url to the icon of the trigger
      helpKey - key of the helppage to open for this trigger
      Throws:
      IllegalArgumentException - if extensionName, displayName or description are null
      Since:
      taskplanner 3.0
  • Method Details

    • getPlaceholderKeys

      public List<String> getPlaceholderKeys()
      Get a list of placeholder key (without placeholder brackets) that are supported by this action.
      Returns:
      a list of placeholder key (without placeholder brackets) that are supported by this action.
      Since:
      taskplanner 20.4