Class ResultActionInfo


  • public final class ResultActionInfo
    extends AbstractInfo
    This holds information on how a ResultAction is to be displayed in the web GUI.
    Since:
    taskplanner 3.0
    • Constructor Summary

      Constructors 
      Constructor Description
      ResultActionInfo​(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey)
      Creates a new ResultActionInfo instance without fields.
      ResultActionInfo​(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey, java.util.List<Field> fields)
      Creates a new ResultActionInfo instance with fields.
      ResultActionInfo​(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey, java.util.List<Field> fields, java.util.List<java.lang.String> placeholderKeys)
      Creates a new ResultActionInfo instance with fields.
    • Constructor Detail

      • ResultActionInfo

        public ResultActionInfo​(java.lang.String extensionName,
                                java.lang.String displayName,
                                java.lang.String description,
                                java.net.URL iconURL,
                                java.lang.String helpKey,
                                java.util.List<Field> fields,
                                java.util.List<java.lang.String> placeholderKeys)
        Creates a new ResultActionInfo instance with fields.
        Parameters:
        extensionName - the unique extensionName, there must be a JobFactory for this extensionName.
        displayName - localized name of the resultAction to show
        description - localized description of the resultAction to show
        iconURL - url to the icon of the resultAction
        helpKey - key of the helppage to open for this resultAction
        fields - List of fields which represents the editable properties of the resultAction
        placeholderKeys - a list of placeholders (without placeholder brackets) that are supported by this action. Allows the definition of own placeholders that will only be used this action.
        Since:
        taskplanner 3.0
      • ResultActionInfo

        public ResultActionInfo​(java.lang.String extensionName,
                                java.lang.String displayName,
                                java.lang.String description,
                                java.net.URL iconURL,
                                java.lang.String helpKey,
                                java.util.List<Field> fields)
        Creates a new ResultActionInfo instance with fields.
        Parameters:
        extensionName - the unique extensionName, there must be a JobFactory for this extensionName.
        displayName - localized name of the resultAction to show
        description - localized description of the resultAction to show
        iconURL - url to the icon of the resultAction
        helpKey - key of the helppage to open for this resultAction
        fields - List of fields which represents the editable properties of the resultAction
        Since:
        taskplanner 3.0
      • ResultActionInfo

        public ResultActionInfo​(java.lang.String extensionName,
                                java.lang.String displayName,
                                java.lang.String description,
                                java.net.URL iconURL,
                                java.lang.String helpKey)
        Creates a new ResultActionInfo instance without fields.
        Parameters:
        extensionName - the unique extensionName, there must be a JobFactory for this extensionName.
        displayName - localized name of the resultAction to show
        description - localized description of the resultAction to show
        iconURL - url to the icon of the resultAction
        helpKey - key of the helppage to open for this resultAction
        Since:
        taskplanner 3.0
    • Method Detail

      • getPlaceholderKeys

        public java.util.List<java.lang.String> getPlaceholderKeys()
        Returns 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 3.0