Interface QCustomPossibleValueProvider<T extends Serializable>

All Known Implementing Classes:

BasicCustomPossibleValueProvider, ScheduledJobTypePossibleValueSource, SchedulersPossibleValueSource, TablesCustomPossibleValueProvider

public interface QCustomPossibleValueProvider<T extends Serializable>

Interface to be implemented by user-defined code that serves as the backing for a CUSTOM type possibleValueSource Type parameter `T` is the id-type of the possible value.

Method Summary

Modifier and Type	Method	Description
default List<QPossibleValue<T>>	completeCustomPVSSearch(SearchPossibleValueSourceInput input, List<QPossibleValue<T>> possibleValues)	meant to be protected (but interface...) - for a custom PVS implementation to complete its search (e.g., after it generates the list of PVS objects, let this method do the filtering).
default List<T>	convertInputIdsToIdType(Class<T> type, List<Serializable> inputIdList)	The input list of ids might come through as a type that isn't the same as the type of the ids in the enum (e.g., strings from a frontend, integers in an enum).
default boolean	doesPossibleValueMatchSearchInput(List<T> idsInType, QPossibleValue<T> possibleValue, SearchPossibleValueSourceInput input)
QPossibleValue<T>	getPossibleValue(Serializable idValue)
List<QPossibleValue<T>>	search(SearchPossibleValueSourceInput input)

Method Details

getPossibleValue

QPossibleValue<T> getPossibleValue(Serializable idValue)

search

List<QPossibleValue<T>> search(SearchPossibleValueSourceInput input)
                        throws QException

Throws:

QException

convertInputIdsToIdType

default List<T> convertInputIdsToIdType(Class<T> type,
 List<Serializable> inputIdList)

The input list of ids might come through as a type that isn't the same as the type of the ids in the enum (e.g., strings from a frontend, integers in an enum). So, this method looks maps a list of input ids to the requested type.

completeCustomPVSSearch

default List<QPossibleValue<T>> completeCustomPVSSearch(SearchPossibleValueSourceInput input,
 List<QPossibleValue<T>> possibleValues)

meant to be protected (but interface...) - for a custom PVS implementation to complete its search (e.g., after it generates the list of PVS objects, let this method do the filtering).

doesPossibleValueMatchSearchInput

default boolean doesPossibleValueMatchSearchInput(List<T> idsInType,
 QPossibleValue<T> possibleValue,
 SearchPossibleValueSourceInput input)