Class JobInfo


  • public final class JobInfo
    extends AbstractInfo
    Contains information about how this kind of job is to be presented, what options with what type it has and how they interact with each other.
    Since:
    taskplanner 3.0
    • Constructor Summary

      Constructors 
      Constructor Description
      JobInfo​(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey)
      Creates a new JobInfo instance with only required fields.
      JobInfo​(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey, ConditionInfo conditionInfo, java.util.List<Field> fields)
      Creates a new JobInfo instance with all optional fields.
      JobInfo​(java.lang.String extensionName, java.lang.String displayName, java.lang.String description, java.net.URL iconURL, java.lang.String helpKey, ConditionInfo conditionInfo, java.util.List<Field> fields, java.util.List<java.lang.String> placeholderKeys)
      Creates a new JobInfo instance with all optional fields.
      JobInfo​(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 JobInfo instance with fields.
      JobInfo​(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 JobInfo instance with fields.
    • Constructor Detail

      • JobInfo

        public JobInfo​(@Nonnull
                       java.lang.String extensionName,
                       @Nonnull
                       java.lang.String displayName,
                       @Nonnull
                       java.lang.String description,
                       java.net.URL iconURL,
                       java.lang.String helpKey,
                       ConditionInfo conditionInfo,
                       java.util.List<Field> fields,
                       java.util.List<java.lang.String> placeholderKeys)
        Creates a new JobInfo instance with all optional fields.
        Parameters:
        extensionName - unique name of the job extension. There must be a JobFactory with this name.
        displayName - localized display name of this job
        description - localized description of this job
        iconURL - URL to the icon for this job
        helpKey - key of the help page to open for this job
        conditionInfo - information about condition(s) this job offers
        fields - list of fields this job has
        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
      • JobInfo

        public JobInfo​(@Nonnull
                       java.lang.String extensionName,
                       @Nonnull
                       java.lang.String displayName,
                       @Nonnull
                       java.lang.String description,
                       java.net.URL iconURL,
                       java.lang.String helpKey,
                       ConditionInfo conditionInfo,
                       @Nonnull
                       java.util.List<Field> fields)
        Creates a new JobInfo instance with all optional fields.
        Parameters:
        extensionName - unique name of the job extension. There must be a JobFactory with this name.
        displayName - localized display name of this job
        description - localized description of this job
        iconURL - URL to the icon for this job
        helpKey - key of the help page to open for this job
        conditionInfo - information about condition(s) this job offers
        fields - list of fields this job has
        Since:
        taskplanner 3.0
      • JobInfo

        public JobInfo​(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 JobInfo instance with fields.
        Parameters:
        extensionName - unique name of the job extension. There must be a JobFactory with this name.
        displayName - localized display name of this job
        description - localized description of this job
        iconURL - URL to the icon for this job
        helpKey - key of the help page to open for this job
        fields - list of fields this job has
        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
      • JobInfo

        public JobInfo​(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 JobInfo instance with fields.
        Parameters:
        extensionName - unique name of the job extension. There must be a JobFactory with this name.
        displayName - localized display name of this job
        description - localized description of this job
        iconURL - URL to the icon for this job
        helpKey - key of the help page to open for this job
        fields - list of fields this job has
        Since:
        taskplanner 3.0
      • JobInfo

        public JobInfo​(java.lang.String extensionName,
                       java.lang.String displayName,
                       java.lang.String description,
                       java.net.URL iconURL,
                       java.lang.String helpKey)
        Creates a new JobInfo instance with only required fields.
        Parameters:
        extensionName - unique name of the job extension. There must be a JobFactory with this name.
        displayName - localized display name of this job
        description - localized description of this job
        iconURL - URL to the icon for this job
        helpKey - key of the help page to open for this job
        Since:
        taskplanner 3.0
    • Method Detail

      • getConditionInfo

        @Nullable
        public ConditionInfo getConditionInfo()
        Get information about the condition this job can have configured.
        Returns:
        the condition info, can be null.
        Since:
        taskplanner 3.0
      • 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