Class AbstractInfo

java.lang.Object
com.inet.taskplanner.server.api.common.AbstractInfo
Direct Known Subclasses:
JobInfo, ResultActionInfo, SeriesInfo, TriggerInfo

@JsonData public abstract class AbstractInfo extends Object
POJO containing information about a dynamic component in the TaskPlanner.

Contains information about how the component is to be presented.

Since:
taskplanner 3.0
See Also:
  • Constructor Details

    • AbstractInfo

      public AbstractInfo(@Nonnull String extensionName, @Nonnull String displayName, @Nonnull String description, URL iconURL, String helpKey)
      Creates a new AbstractInfo instance only with required fields.
      Parameters:
      extensionName - the unique extensionName, there must be a JobFactory for this extensionName.
      displayName - localized name of the component to show
      description - localized description of the component to show
      iconURL - url to the icon of the component
      helpKey - key of the helppage to open for this component
      Since:
      taskplanner 3.0
    • AbstractInfo

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

    • getExtensionName

      @Nonnull public String getExtensionName()
      Returns the extensionName for the component this info is describing.
      Returns:
      the extension name.
    • getDisplayName

      @Nonnull public String getDisplayName()
      Get the localized display name of the component.
      Returns:
      the localized display name
      Since:
      taskplanner 3.0
    • getDescription

      @Nonnull public String getDescription()
      Get the localized description of the component.
      Returns:
      the description for the component.
      Since:
      taskplanner 3.0
    • getIconURL

      @Nullable public URL getIconURL()
      Get the URL of the Icon for the component.
      Returns:
      the url of the icon
      Since:
      taskplanner 3.0
    • getHelpKey

      @Nullable public String getHelpKey()
      Get the help-key of the page to open for the component.
      Returns:
      the help key
      Since:
      taskplanner 3.0
    • getFields

      public List<Field> getFields()
      Returns the list of fields that contains the property entries.
      Returns:
      the list of Fields.
      Since:
      taskplanner 3.0