Interface FilterComponentRegistration
- All Known Implementing Classes:
FilterComponentRegistrationImpl
public interface FilterComponentRegistration
Registers a UI filter component in the framework. Registered components can be
used inside a
Configuration
.
For instance:
@Configuration public class FilterComponentConfiguration { @Bean public FilterComponentRegistration registerPropertyFilterComponent() { return FilterComponentRegistrationBuilder.create(PropertyFilter.class, PropertyFilterCondition.class, PropertyFilterConverter.class) .build(); } }
-
Method Summary
Modifier and TypeMethodDescriptionClass<? extends FilterComponent>
Returns a class of the UI filter component.Class<? extends FilterConverter<? extends FilterComponent,
? extends FilterCondition>> Returns a converter class.Returns an id of the model detail view.Class<? extends FilterCondition>
Returns a class of non-persistent entity that stores the state of the UI filter component.
-
Method Details
-
getComponentClass
Class<? extends FilterComponent> getComponentClass()Returns a class of the UI filter component.- Returns:
- a class of the UI filter component
-
getModelClass
Class<? extends FilterCondition> getModelClass()Returns a class of non-persistent entity that stores the state of the UI filter component. The model class is used to save filter component state in DB and is used to display and change the state of the filter component at runtime.- Returns:
- a model class
-
getConverterClass
Class<? extends FilterConverter<? extends FilterComponent,? extends FilterCondition>> getConverterClass()Returns a converter class. The converter is used to convert between a UI filter component and model classes.- Returns:
- a converter class
-
getDetailViewId
Returns an id of the model detail view.- Returns:
- an id of the model detail view
-