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 Summary
Fields Modifier and Type Field Description static java.lang.String
PROTOCOL_FILE
Default protocol for the local server file system
-
Constructor Summary
Constructors Constructor Description FolderField(java.lang.String key, java.lang.String label)
Creates the field for choosing a folder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.util.List<java.lang.String>
getAllAvailableProtocols()
Returns a list of all registered protocols that can be used.java.lang.String
patchResultPlaceholderInValue(java.lang.String value, java.util.List<JobResultContainer> results)
Override to replace the placeholders with the values from the resultsjava.lang.String
patchSeriesPlaceholderInValue(java.lang.String value, java.util.Map<java.lang.String,java.lang.String> seriesProperties)
Override to replace the placeholders with the values from the seriesvoid
setProtocols(java.util.List<java.lang.String> protocols)
Sets the possible protocols.-
Methods inherited from class com.inet.taskplanner.server.api.field.Field
getConditions, getKey, getLabel, getPlaceholder, getType, getValue, isUpdateValuesOnChange, isValueSavable, replaceSeriesPlaceholders, setConditions, setKey, setLabel, setPlaceholder, setType, setType, setUpdateValuesOnChange, setValue, setValueSavable
-
-
-
-
Field Detail
-
PROTOCOL_FILE
public static final java.lang.String PROTOCOL_FILE
Default protocol for the local server file system- See Also:
- Constant Field Values
-
-
Method Detail
-
setProtocols
public void setProtocols(java.util.List<java.lang.String> protocols)
Sets the possible protocols. ['file') is the default.- Parameters:
protocols
- the list of possible protocols- Since:
- taskplanner 3.0
-
patchSeriesPlaceholderInValue
public java.lang.String patchSeriesPlaceholderInValue(java.lang.String value, java.util.Map<java.lang.String,java.lang.String> seriesProperties)
Override to replace the placeholders with the values from the series- Overrides:
patchSeriesPlaceholderInValue
in classField
- Parameters:
value
- the value to be patchedseriesProperties
- properties from the current series set- Returns:
- the new value with replaced placeholders
-
patchResultPlaceholderInValue
public java.lang.String patchResultPlaceholderInValue(java.lang.String value, java.util.List<JobResultContainer> results)
Override to replace the placeholders with the values from the results- Overrides:
patchResultPlaceholderInValue
in classField
- Parameters:
value
- the value to be patchedresults
- the results that contain the meta properties that are replaced- Returns:
- the new value with replaced placeholders
-
getAllAvailableProtocols
public static java.util.List<java.lang.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
-
-