Class FolderField
java.lang.Object
com.inet.taskplanner.server.api.field.Field
com.inet.taskplanner.server.api.field.FolderField
- Direct Known Subclasses:
FileField
,FileOrFolderField
A field that allows the definition of folder.
- Since:
- taskplanner 3.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Default protocol for the local server file system -
Constructor Summary
ConstructorsConstructorDescriptionFolderField
(String key, String label) Creates the field for choosing a folder -
Method Summary
Modifier and TypeMethodDescriptionReturns a list of all registered protocols that can be used.patchResultPlaceholderInValue
(String value, List<JobResultContainer> results) Override to replace the placeholders with the values from the resultspatchSeriesPlaceholderInValue
(String value, Map<String, String> seriesProperties) Override to replace the placeholders with the values from the seriesvoid
setProtocols
(List<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 Details
-
PROTOCOL_FILE
Default protocol for the local server file system- See Also:
-
-
Constructor Details
-
FolderField
Creates the field for choosing a folder- Parameters:
key
- the key of the fieldlabel
- the label to be displayed in front of the field- Since:
- taskplanner 3.0
-
-
Method Details
-
setProtocols
Sets the possible protocols. ['file') is the default.- Parameters:
protocols
- the list of possible protocols- Since:
- taskplanner 3.0
-
patchSeriesPlaceholderInValue
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
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
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
-