Package com.storedobject.ui

Interface ObjectLoader<T extends StoredObject>

All Superinterfaces:

FilterMethods<T>, ObjectLoader<T>

All Known Subinterfaces:

ObjectGridData<T,ROOT>

All Known Implementing Classes:

AbstractCheckListForestBrowser, AbstractInvoiceBrowser, AbstractLinkGrid, AbstractObjectForest, AbstractReceiveMaterialReturned, AbstractReceiveMaterialTransferred, AbstractRequestMaterial, AbstractReturnMaterial, AbstractSale, AbstractSendAndReceiveMaterial, ApproveTransaction, BaseCustomerInvoiceBrowser, BaseObjectForest, BaseProcessMaterialRequest, BaseReceiveMaterialRequested, BaseRequestMaterial, BaseSupplierInvoiceBrowser, BlockComboField, CheckListForestBrowser, CrossServerManager, CustomerInvoiceBrowser, DataView, DetailLinkGrid, EditableObjectGrid, EditableObjectListProvider, FileManager, FileViewer, FileViewerGrid, GRN, InquiryBrowser, ItemComboField, ItemsSentForRepair, JournalVoucherBrowser, LoanOutItems, LocationField, LocationMonitoring, ManageBiometric, MemoSystem, ObjectBrowser, ObjectBrowserEditor, ObjectBrowserViewer, ObjectComboField, ObjectForest, ObjectForestBrowser, ObjectForestEditor, ObjectForestProvider, ObjectForestViewer, ObjectGrid, ObjectListEditor, ObjectListField, ObjectListGrid, ObjectListProvider, ObjectMemoryGrid, ObjectSearchBrowser, ObjectTree, ObjectTreeBrowser, ObjectTreeEditor, ObjectTreeProvider, ObjectTreeViewer, PackingUnitBrowser, POBrowser, ProcessMaterialRequest, ReceiveMaterialRequested, ReceiveMaterialReturned, ReceiveMaterialTransferred, ReferenceLinkGrid, ReferenceLinkListProvider, RequestMaterial, RequestTool, RestrictedSystemUserBrowser, ReturnMaterial, Sale, SendItemsForRepair, SendItemsOut, SupplierInvoiceBrowser, SupportSystem, SystemUserGroupBrowser, TemplateBrowser, TextContentBrowser, TicketingSystem, ToolMonitoring, TransferMaterial, UnitDefinitionBrowser

public interface ObjectLoader<T extends StoredObject>
extends ObjectLoader<T>

Method Summary

Modifier and Type	Method	Description
default com.vaadin.flow.shared.Registration	addDataLoadedListener(DataLoadedListener listener)
default void	applyFilterPredicate()	This method is called whenever a filter predicate is changed.
default void	clear(boolean refresh)	Deprecated. Just use {ObjectLoader.clear()} only, "refresh" flag is not more required.
default T	get(int index)
default int	getCacheLevel()
default ObjectLoader<T>	getDelegatedLoader()
default String	getEffectiveCondition(String condition)	Get the "effective" filter condition that must be applied for loading.
default ObjectLoadFilter<T>	getFixedFilter()
default ObjectLoadFilter<T>	getLoadFilter()	Get the load filter.
default int	getObjectCount()
default int	indexOf(T object)
default void	load(ObjectIterator<T> objectIterator)	Load the given instances.
default void	setExtraFilter(FilterProvider fixedFilterProvider)	Deprecated. Please use setFixedFilter(FilterProvider) instead.
default void	setExtraFilter(String fixedFilter)	Deprecated. Please use setFixedFilter(String) instead.
default void	setFilter(Predicate<T> predicate)	Deprecated. Use FilterMethods.setViewFilter(Predicate) instead.
default void	setFilter(Predicate<T> predicate, boolean refresh)	Deprecated. Use FilterMethods.setViewFilter(Predicate, boolean) instead.
default void	setFixedFilter(FilterProvider fixedFilterProvider)	Set a fixed filter that will be automatically added to any filter that is set later.
default void	setFixedFilter(FilterProvider fixedFilterProvider, boolean apply)	Set a fixed filter that will be automatically added to any filter that is set later.
default void	setFixedFilter(String fixedFilter)	Set a fixed filter that will be automatically added to any filter that is set later.
default void	setFixedFilter(String fixedFilter, boolean apply)	Set a fixed filter that will be automatically added to any filter that is set later.
default int	size()	Get the instances count.
default Stream<T>	streamAll()
default Stream<T>	streamFiltered()

Methods inherited from interface com.storedobject.core.FilterMethods

getFilterCondition, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setLoadFilter, setViewFilter, setViewFilter

Methods inherited from interface com.storedobject.core.ObjectLoader

applyFilter, canContain, clear, getAllowAny, getLinkType, getMaster, getObjectClass, getOrderBy, isAllowAny, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, reload, setLinkType, setLinkType, setMaster, setMaster, setOrderBy, setOrderBy

Method Details

clear

@Deprecated
default void clear(boolean refresh)

Deprecated.

Just use {ObjectLoader.clear()} only, "refresh" flag is not more required.

Clear the entries and refresh it.

Parameters:

refresh - Whether to refresh or not.

size

default int size()

Description copied from interface: ObjectLoader

Get the instances count.

Specified by:

size in interface ObjectLoader<T extends StoredObject>

Returns:

Count.

getObjectCount

default int getObjectCount()

get

default T get(int index)

indexOf

default int indexOf(T object)

streamAll

default Stream<T> streamAll()

streamFiltered

default Stream<T> streamFiltered()

getCacheLevel

default int getCacheLevel()

getFixedFilter

default ObjectLoadFilter<T> getFixedFilter()

getEffectiveCondition

default String getEffectiveCondition(String condition)

Description copied from interface: FilterMethods

Get the "effective" filter condition that must be applied for loading. The result from FilterMethods.getFilterCondition() will be passed as a parameter to this method to get a modified "condition" if required.

Specified by:

getEffectiveCondition in interface FilterMethods<T extends StoredObject>

Parameters:

condition - Condition obtained from FilterMethods.getFilterCondition().

Returns:

Modified condition or the same if no modification required.

setExtraFilter

@Deprecated
default void setExtraFilter(FilterProvider fixedFilterProvider)

Deprecated.

Please use setFixedFilter(FilterProvider) instead.

Set a fixed filter that will be automatically added to any filter that is set later.

Parameters:

fixedFilterProvider - Filter condition to set.

setFixedFilter

default void setFixedFilter(FilterProvider fixedFilterProvider)

Set a fixed filter that will be automatically added to any filter that is set later.

Parameters:

fixedFilterProvider - Filter condition to set.

setFixedFilter

default void setFixedFilter(FilterProvider fixedFilterProvider,
 boolean apply)

Set a fixed filter that will be automatically added to any filter that is set later.

Parameters:

fixedFilterProvider - Filter condition to set.

apply - Whether to apply immediately or not.

setExtraFilter

@Deprecated
default void setExtraFilter(String fixedFilter)

Deprecated.

Please use setFixedFilter(String) instead.

Set a fixed filter that will be automatically added to any filter that is set later.

Parameters:

fixedFilter - Filter condition to set.

setFixedFilter

default void setFixedFilter(String fixedFilter)

Set a fixed filter that will be automatically added to any filter that is set later.

Parameters:

fixedFilter - Filter condition to set.

setFixedFilter

default void setFixedFilter(String fixedFilter,
 boolean apply)

Set a fixed filter that will be automatically added to any filter that is set later.

Parameters:

fixedFilter - Filter condition to set.

apply - Whether to apply immediately or not.

load

default void load(ObjectIterator<T> objectIterator)

Description copied from interface: ObjectLoader

Load the given instances. Current "load filter" if set will be applied. However, ObjectLoader.getOrderBy() result will be ignored. Also, the value returned by ObjectLoader.getAllowAny() will determine whether instanced of the subclasses to be restricted or not.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

objectIterator - Objects to be loaded.

getLoadFilter

@Nonnull
default ObjectLoadFilter<T> getLoadFilter()

Description copied from interface: FilterMethods

Get the load filter.

Specified by:

getLoadFilter in interface FilterMethods<T extends StoredObject>

Returns:

Current load filter.

applyFilterPredicate

default void applyFilterPredicate()

Description copied from interface: FilterMethods

This method is called whenever a filter predicate is changed. Methods with default implementation already invoke this method. If any of those methods are overridden, make sure that it invokes this method so that logic to handle filter changes can be coded here.

Note: This method is used to show the filtered result of the existing entries

Specified by:

applyFilterPredicate in interface FilterMethods<T extends StoredObject>

setFilter

@Deprecated
default void setFilter(Predicate<T> predicate)

Deprecated.

Use FilterMethods.setViewFilter(Predicate) instead.

Set view filter.

Parameters:

predicate - Predicate to set.

setFilter

@Deprecated
default void setFilter(Predicate<T> predicate,
 boolean refresh)

Deprecated.

Use FilterMethods.setViewFilter(Predicate, boolean) instead.

Set view filter.

Parameters:

predicate - Predicate to set.

refresh - Whether to refresh the view immediately or not.

addDataLoadedListener

default com.vaadin.flow.shared.Registration addDataLoadedListener(DataLoadedListener listener)

getDelegatedLoader

default ObjectLoader<T> getDelegatedLoader()