Interface TaskFieldListGenerator
public interface TaskFieldListGenerator
provides data entries for field type dropdowns in task fields as well as generating the actual task Field instances themselves
- Since:
- taskplanner 5.0
-
Method Summary
Modifier and TypeMethodDescriptiongenerateFilterableFieldList
(Set<String> filterTypes) generates the task planner Field instances including a filter type drop down box, for the given filter typesgetEntriesFor
(String fieldType) returns any known entries for the given field type constant/idgetEntriesFor
(String fieldType, String filter, String customValue) returns any known entries for the given field type constant/id including filtering.
-
Method Details
-
getEntriesFor
returns any known entries for the given field type constant/id- Parameters:
fieldType
- type of field to fetch entries for (known by the implementors/callers of this interface)- Returns:
- data entries for this field type
- Since:
- taskplanner 5.0
-
getEntriesFor
returns any known entries for the given field type constant/id including filtering. Returning null means this generator is not responsible for generating entries for this field type. Returning not-null (including empty list!!) means this generator IS responsible for generating entries for this field type which means other generators will no longer be asked.- Parameters:
fieldType
- type of field to fetch entries for (known by the implementors/callers of this interface)filter
- the entered filter from the client. Can be used to filter down the entries or to add custom valuescustomValue
- the optional custom value to be added to the list- Returns:
- data entries for this field type. Returning null means this generator is not responsible for generating entries for this field type. Returning not-null (including empty list!!) means this generator IS responsible for generating entries for this field type which means other generators will no longer be asked.
- Since:
- taskplanner 22.4
-
generateFilterableFieldList
generates the task planner Field instances including a filter type drop down box, for the given filter types- Parameters:
filterTypes
- which filter types to support (known by the implementors/callers of this interface)- Returns:
- task planner Field instances including a filter type drop down box, for the given filter types
- Since:
- taskplanner 5.0
-