Class FolderField

java.lang.Object
com.inet.taskplanner.server.api.field.Field
com.inet.taskplanner.server.api.field.FolderField
Direct Known Subclasses:
FileField, FileOrFolderField

@JsonData public class FolderField extends Field
A field that allows the definition of folder.
Since:
taskplanner 3.0
  • Field Details

    • PROTOCOL_FILE

      public static final String PROTOCOL_FILE
      Default protocol for the local server file system
      See Also:
  • Constructor Details

    • FolderField

      public FolderField(String key, String label)
      Creates the field for choosing a folder
      Parameters:
      key - the key of the field
      label - the label to be displayed in front of the field
      Since:
      taskplanner 3.0
  • Method Details

    • setProtocols

      public void setProtocols(List<String> protocols)
      Sets the possible protocols. ['file') is the default.
      Parameters:
      protocols - the list of possible protocols
      Since:
      taskplanner 3.0
    • patchSeriesPlaceholderInValue

      public String patchSeriesPlaceholderInValue(String value, Map<String,String> seriesProperties)
      Override to replace the placeholders with the values from the series
      Overrides:
      patchSeriesPlaceholderInValue in class Field
      Parameters:
      value - the value to be patched
      seriesProperties - properties from the current series set
      Returns:
      the new value with replaced placeholders
    • patchResultPlaceholderInValue

      public String patchResultPlaceholderInValue(String value, List<JobResultContainer> results)
      Override to replace the placeholders with the values from the results
      Overrides:
      patchResultPlaceholderInValue in class Field
      Parameters:
      value - the value to be patched
      results - the results that contain the meta properties that are replaced
      Returns:
      the new value with replaced placeholders
    • getAllAvailableProtocols

      public static List<String> getAllAvailableProtocols()
      Returns a list of all registered protocols that can be used. It includes no permission check!
      Returns:
      a list of all registered protocols.
      Since:
      taskplanner 3.0