Interface TaskFieldListGenerator

public interface TaskFieldListGenerator

Provides data entries for field-type dropdowns in task fields and generates the corresponding task field instances.

Since:

taskplanner 5.0

Method Summary

Modifier and Type	Method	Description
List<Field>	generateFilterableFieldList()	Generates Task Planner field instances, including a filter-type dropdown, for the given filter types.
List<DataEntry>	getEntriesFor(String fieldType)	Returns known entries for the given field-type constant or ID.
default List<DataEntry>	getEntriesFor(String fieldType, String filter, String customValue)	Returns known entries for the given field-type constant or ID, including filtering.

Method Details

getEntriesFor

List<DataEntry> getEntriesFor(String fieldType)

Returns known entries for the given field-type constant or 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

default List<DataEntry> getEntriesFor(String fieldType,
 String filter,
 String customValue)

Returns known entries for the given field-type constant or ID, including filtering. Returning null means this generator is not responsible for generating entries for this field type. Returning a non-null value, including an empty list, means this generator is responsible for generating entries for this field type, so other generators will not 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 values

customValue - 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 a non-null value, including an empty list, means this generator is responsible for generating entries for this field type, so other generators will not be asked.

Since:

taskplanner 22.4

generateFilterableFieldList

List<Field> generateFilterableFieldList()

Generates Task Planner field instances, including a filter-type dropdown, for the given filter types.

Returns:

Task Planner field instances, including a filter-type dropdown, for the given filter types

Since:

taskplanner 5.0