Package com.storedobject.core

Interface ObjectLoader<T extends StoredObject>

Type Parameters:

T - Type of StoredObject.

All Superinterfaces:

FilterMethods<T>

All Known Subinterfaces:

ObjectGridData<T,ROOT>, ObjectList<T>, ObjectLoader<T>

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, ItemComboField, ItemsSentForRepair, JournalVoucherBrowser, LocationField, LocationMonitoring, ManageBiometric, MemoSystem, ObjectBrowser, ObjectBrowserEditor, ObjectBrowserViewer, ObjectCache, ObjectCacheList, ObjectComboField, ObjectForest, ObjectForest, ObjectForestBrowser, ObjectForestEditor, ObjectForestProvider, ObjectForestViewer, ObjectGrid, ObjectListEditor, ObjectListField, ObjectListGrid, ObjectListProvider, ObjectMemoryGrid, ObjectMemoryList, ObjectSearchBrowser, ObjectTable, ObjectTree, ObjectTree, ObjectTreeBrowser, ObjectTreeEditor, ObjectTreeProvider, ObjectTreeViewer, PackingUnitBrowser, POBrowser, POItemBrowser, ProcessMaterialRequest, ReceiveMaterialRequested, ReceiveMaterialReturned, ReceiveMaterialTransferred, ReferenceLinkGrid, ReferenceLinkListProvider, RequestMaterial, RequestTool, RestrictedSystemUserBrowser, ReturnMaterial, ReturnTool, Sale, SendItemsForRepair, SupplierInvoiceBrowser, SupportSystem, SystemUserGroupBrowser, TemplateBrowser, TextContentBrowser, ToolMonitoring, TransferMaterial, UnitDefinitionBrowser

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

Methods for loading instances of StoredObject.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
default void	applyFilter()	This method is called whenever a filter condition is changed.
default boolean	canContain(T object)	Check whether the given object could be there in the objects loaded by this loader.
default void	clear()	Clear - remove all entries.
default boolean	getAllowAny()	Retrieve sub-classes?
default int	getLinkType()	Get the current link type.
default StoredObject	getMaster()	Get the current master instance if available.
Class<T>	getObjectClass()	The class of the instances.
default String	getOrderBy()	Get the current "ORDER BY" clause.
default boolean	isAllowAny()	Retrieve sub-classes?
default void	load()	Load the instances.
default void	load(boolean any)	Load the instances.
default void	load(int linkType, StoredObject master)	Load the links of the given "master" instance.
default void	load(int linkType, StoredObject master, boolean any)	Load the links of the given "master" instance.
default void	load(int linkType, StoredObject master, String condition)	Load the links of the given "master" instance.
default void	load(int linkType, StoredObject master, String condition, boolean any)	Load the links of the given "master" instance.
default void	load(int linkType, StoredObject master, String condition, String orderedBy)	Load the links of the given "master" instance.
default void	load(int linkType, StoredObject master, String condition, String orderedBy, boolean any)	Load the links of the given "master" instance.
void	load(ObjectIterator<T> objects)	Load the given instances.
default void	load(Query query)	Load the instances created from the query.
default void	load(Query query, boolean any)	Load the instances created from the query.
default void	load(StoredObject master, String condition)	Load the links of the given "master" instance.
default void	load(StoredObject master, String condition, boolean any)	Load the links of the given "master" instance.
default void	load(StoredObject master, String condition, String orderedBy)	Load the links of the given "master" instance.
default void	load(StoredObject master, String condition, String orderedBy, boolean any)	Load the links of the given "master" instance.
default void	load(Iterable<Id> idList)	Load the instances created from the list of Ids.
default void	load(String condition)	Load the instances.
default void	load(String condition, boolean any)	Load the instances.
default void	load(String condition, String orderedBy)	Load the instances.
default void	load(String condition, String orderedBy, boolean any)	Load the instances.
default void	load(Collection<T> objects)	Load the given instances.
default void	load(Stream<T> objects)	Load the given instances.
default void	load(T... objects)	Load the given instances.
default void	reload()	Reload all entries.
default void	setLinkType(int linkType)	Set the link type.
default void	setLinkType(int linkType, boolean load)	Set the link type.
default void	setMaster(StoredObject master)	Set the master instance.
default void	setMaster(StoredObject master, boolean load)	Set the master instance.
default void	setOrderBy(String orderBy)	Set the "ORDER BY" clause.
default void	setOrderBy(String orderBy, boolean load)	Set the "ORDER BY" clause.
int	size()	Get the instances count.

Methods inherited from interface com.storedobject.core.FilterMethods

applyFilterPredicate, getEffectiveCondition, getFilterCondition, getLoadFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setLoadFilter, setViewFilter, setViewFilter

Method Details

isAllowAny

default boolean isAllowAny()

Retrieve sub-classes?

Returns:

Whether instanced of the subclasses to be retrieved or not.

getAllowAny

default boolean getAllowAny()

Retrieve sub-classes?

Returns:

Whether instanced of the subclasses to be retrieved or not. (Same as isAllowAny()).

getOrderBy

default String getOrderBy()

Get the current "ORDER BY" clause.

Returns:

Current "ORDER BY" clause.

setOrderBy

default void setOrderBy(String orderBy)

Set the "ORDER BY" clause.

Parameters:

orderBy - "ORDER BY" clause to set.

setOrderBy

default void setOrderBy(String orderBy,
 boolean load)

Set the "ORDER BY" clause.

Parameters:

orderBy - "ORDER BY" clause to set.

load - Whether to immediately reload with this "ORDER BY" clause or not.

getMaster

default StoredObject getMaster()

Get the current master instance if available.

Returns:

Current master instance if available.

setMaster

default void setMaster(StoredObject master)

Set the master instance.

Parameters:

master - Master instance.

setMaster

default void setMaster(StoredObject master,
 boolean load)

Set the master instance.

Parameters:

master - Master instance.

load - Whether to immediately reload with this master or not.

getLinkType

default int getLinkType()

Get the current link type.

Returns:

Link type.

setLinkType

default void setLinkType(int linkType)

Set the link type.

Parameters:

linkType - Link type to set.

setLinkType

default void setLinkType(int linkType,
 boolean load)

Set the link type.

Parameters:

linkType - Link type to set.

load - Whether to immediately reload with this link type or not. (Applicable only if master is available).

reload

default void reload()

Reload all entries.

applyFilter

default void applyFilter()

Description copied from interface: FilterMethods

This method is called whenever a filter condition 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.

Specified by:

applyFilter in interface FilterMethods<T extends StoredObject>

clear

default void clear()

Clear - remove all entries.

load

default void load()

Load the instances. Current filtering conditions (return value of FilterMethods.getFilterCondition()) including "load filter" if set will be applied. Also, the value returned by getAllowAny() will determine whether instanced of the subclasses to be retrieved or not. The order will be determined by the return value of getOrderBy(). If "master" is already set, "links" of the "master" will be loaded.

load

default void load(boolean any)

Load the instances. Current filtering conditions (return value of FilterMethods.getFilterCondition()) including "load filter" if set will be applied. The order will be determined by the return value of getOrderBy(). If "master" is already set, "links" of the "master" will be loaded.

Parameters:

any - Whether instanced of the subclasses to be retrieved or not.

load

default void load(String condition)

Load the instances. Current "load filter" if set will be applied. Also, the value returned by getAllowAny() will determine whether instanced of the subclasses to be retrieved or not. The order will be determined by the return value of getOrderBy(). If "master" is already set, "links" of the "master" will be loaded.

Parameters:

condition - Filtering condition to be applied.

load

default void load(String condition,
 boolean any)

Load the instances. Current "load filter" if set will be applied. The order will be determined by the return value of getOrderBy(). If "master" is already set, "links" of the "master" will be loaded.

Parameters:

condition - Filtering condition to be applied.

any - Whether instanced of the subclasses to be retrieved or not.

load

default void load(String condition,
 String orderedBy)

Load the instances. Current "load filter" if set will be applied. Also, the value returned by getAllowAny() will determine whether instanced of the subclasses to be retrieved or not. If "master" is already set, "links" of the "master" will be loaded.

Parameters:

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

load

default void load(String condition,
 String orderedBy,
 boolean any)

Load the instances. Current "load filter" if set will be applied. If "master" is already set, "links" of the "master" will be loaded.

Parameters:

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

load

default void load(StoredObject master,
 String condition)

Load the links of the given "master" instance. Current "load filter" if set will be applied. Also, the value returned by getAllowAny() will determine whether instanced of the subclasses to be retrieved or not. The order will be determined by the return value of getOrderBy().

Parameters:

master - Master instance.

condition - Filtering condition to be applied.

load

default void load(StoredObject master,
 String condition,
 boolean any)

Load the links of the given "master" instance. Current "load filter" if set will be applied. The order will be determined by the return value of getOrderBy().

Parameters:

master - Master instance.

condition - Filtering condition to be applied.

any - Whether instanced of the subclasses to be retrieved or not.

load

default void load(StoredObject master,
 String condition,
 String orderedBy)

Load the links of the given "master" instance. Current "load filter" if set will be applied. The order will be determined by the return value of getOrderBy().

Parameters:

master - Master instance.

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

load

default void load(StoredObject master,
 String condition,
 String orderedBy,
 boolean any)

Load the links of the given "master" instance. Current "load filter" if set will be applied.

Parameters:

master - Master instance.

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

load

default void load(int linkType,
 StoredObject master)

Load the links of the given "master" instance. Current filtering conditions (return value of FilterMethods.getFilterCondition()) including "load filter" if set will be applied. Also, the value returned by getAllowAny() will determine whether instanced of the subclasses to be retrieved or not. The order will be determined by the return value of getOrderBy().

Parameters:

linkType - Link type.

master - Master instance.

load

default void load(int linkType,
 StoredObject master,
 boolean any)

Load the links of the given "master" instance. Current filtering conditions (return value of FilterMethods.getFilterCondition()) including "load filter" if set will be applied. The order will be determined by the return value of getOrderBy().

Parameters:

linkType - Link type.

master - Master instance.

any - Whether instanced of the subclasses to be retrieved or not.

load

default void load(int linkType,
 StoredObject master,
 String condition)

Load the links of the given "master" instance. Current "load filter" if set will be applied. Also, the value returned by getAllowAny() will determine whether instanced of the subclasses to be retrieved or not. The order will be determined by the return value of getOrderBy().

Parameters:

linkType - Link type.

master - Master instance.

condition - Filtering condition to be applied.

load

default void load(int linkType,
 StoredObject master,
 String condition,
 boolean any)

Load the links of the given "master" instance. Current "load filter" if set will be applied. The order will be determined by the return value of getOrderBy().

Parameters:

linkType - Link type.

master - Master instance.

condition - Filtering condition to be applied.

any - Whether instanced of the subclasses to be retrieved or not.

load

default void load(int linkType,
 StoredObject master,
 String condition,
 String orderedBy)

Load the links of the given "master" instance. Current "load filter" if set will be applied. The order will be determined by the return value of getOrderBy().

Parameters:

linkType - Link type.

master - Master instance.

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

load

default void load(int linkType,
 StoredObject master,
 String condition,
 String orderedBy,
 boolean any)

Load the links of the given "master" instance. Current "load filter" if set will be applied.

Parameters:

linkType - Link type.

master - Master instance.

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

load

default void load(T... objects)

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

Parameters:

objects - Objects to be loaded.

load

default void load(Collection<T> objects)

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

Parameters:

objects - Objects to be loaded.

load

default void load(Query query)

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

Parameters:

query - Query from which objects to be loaded.

load

default void load(Query query,
 boolean any)

Load the instances created from the query. Current "load filter" if set will be applied. However, getOrderBy() result will be ignored.

Parameters:

query - Query from which objects to be loaded.

any - Whether instanced of the subclasses to be retrieved or not.

load

default void load(Iterable<Id> idList)

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

Parameters:

idList - List of Ids from which objects to be loaded.

load

default void load(Stream<T> objects)

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

Parameters:

objects - Objects to be loaded.

load

void load(ObjectIterator<T> objects)

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

Parameters:

objects - Objects to be loaded.

getObjectClass

Class<T> getObjectClass()

The class of the instances.

Returns:

The class of the instances to load.

size

int size()

Get the instances count.

Returns:

Count.

canContain

default boolean canContain(T object)

Check whether the given object could be there in the objects loaded by this loader.

Note: For customized loaders, this may not check the custom conditions.

Parameters:

object - Object to check.

Returns:

True/false.