LoadContext (CUBA 6.8 API)

java.lang.Object
- com.haulmont.cuba.core.global.LoadContext<E>

All Implemented Interfaces:: DataLoadContext, java.io.Serializable

public class LoadContext<E extends Entity>
extends java.lang.Object
implements DataLoadContext, java.io.Serializable

Class that defines parameters for loading entities from the database via DataManager.

Typical usage:

    LoadContext<User> context = LoadContext.create(User.class).setQuery(
            LoadContext.createQuery("select u from sec$User u where u.login like :login")
                    .setParameter("login", "a%")
                    .setMaxResults(10))
            .setView("user.browse");
    List<User> users = dataManager.loadList(context);

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LoadContext.Query
Class that defines a query to be executed for data loading.

Nested Classes
Modifier and Type	Class and Description
`static class`	`LoadContext.Query` Class that defines a query to be executed for data loading.

Constructor Summary

Constructors
Constructor and Description

LoadContext(java.lang.Class<E> javaClass)

LoadContext(MetaClass metaClass)

Constructors
Constructor and Description
`LoadContext(java.lang.Class<E> javaClass)`
`LoadContext(MetaClass metaClass)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LoadContext<?>`	`copy()` Creates a copy of this LoadContext instance.
`static <E extends Entity> LoadContext<E>`	`create(java.lang.Class<E> entityClass)` Factory method to create a LoadContext instance.
`static LoadContext.Query`	`createQuery(java.lang.String queryString)` Factory method to create a LoadContext.Query instance for passing into `setQuery(Query)` method.
`java.util.Map<java.lang.String,java.lang.Object>`	`getDbHints()`
`java.lang.Object`	`getId()`
`java.lang.String`	`getMetaClass()`
`java.util.List<LoadContext.Query>`	`getPrevQueries()` Allows to execute query on a previous query result.
`LoadContext.Query`	`getQuery()`
`int`	`getQueryKey()`
`View`	`getView()`
`boolean`	`isLoadDynamicAttributes()`
`boolean`	`isLoadPartialEntities()`
`boolean`	`isSoftDeletion()`
`LoadContext<E>`	`setId(java.lang.Object id)`
`LoadContext<E>`	`setLoadDynamicAttributes(boolean loadDynamicAttributes)`
`LoadContext<E>`	`setLoadPartialEntities(boolean loadPartialEntities)` Whether to load partial entities.
`LoadContext<E>`	`setQuery(LoadContext.Query query)`
`LoadContext<E>`	`setQueryKey(int queryKey)`
`LoadContext.Query`	`setQueryString(java.lang.String queryString)`
`LoadContext<E>`	`setSoftDeletion(boolean softDeletion)`
`LoadContext<E>`	`setView(java.lang.String viewName)`
`LoadContext<E>`	`setView(View view)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LoadContext
```
public LoadContext(MetaClass metaClass)
```
    Parameters:
    
    metaClass - metaclass of the loaded entities
  - LoadContext
```
public LoadContext(java.lang.Class<E> javaClass)
```
    Parameters:
    
    javaClass - class of the loaded entities
- Method Detail
  - create
```
public static <E extends Entity> LoadContext<E> create(java.lang.Class<E> entityClass)
```
    Factory method to create a LoadContext instance.
    
    Parameters:
    
    entityClass - class of the loaded entities
  - createQuery
```
public static LoadContext.Query createQuery(java.lang.String queryString)
```
    Factory method to create a LoadContext.Query instance for passing into setQuery(Query) method.
    
    Parameters:
    
    queryString - JPQL query string. Only named parameters are supported.
  - getMetaClass
```
public java.lang.String getMetaClass()
```
    Returns:
    
    name of metaclass of the loaded entities
  - getQuery
```
public LoadContext.Query getQuery()
```
    Returns:
    
    query definition
  - setQuery
```
public LoadContext<E> setQuery(LoadContext.Query query)
```
    Parameters:
    
    query - query definition
    
    Returns:
    
    this instance for chaining
  - setQueryString
```
public LoadContext.Query setQueryString(java.lang.String queryString)
```
    Specified by:
    
    setQueryString in interface DataLoadContext
    
    Parameters:
    
    queryString - JPQL query string. Only named parameters are supported.
    
    Returns:
    
    query definition object
  - getView
```
public View getView()
```
    Returns:
    
    view that is used for loading entities
  - setView
```
public LoadContext<E> setView(View view)
```
    Parameters:
    
    view - view that is used for loading entities
    
    Returns:
    
    this instance for chaining
  - setView
```
public LoadContext<E> setView(java.lang.String viewName)
```
    Parameters:
    
    viewName - view that is used for loading entities
    
    Returns:
    
    this instance for chaining
  - getId
```
public java.lang.Object getId()
```
    Returns:
    
    id of an entity to be loaded
  - setId
```
public LoadContext<E> setId(java.lang.Object id)
```
    Parameters:
    
    id - id of an entity to be loaded
    
    Returns:
    
    this instance for chaining
  - isSoftDeletion
```
public boolean isSoftDeletion()
```
    Returns:
    
    whether to use soft deletion when loading entities
  - setSoftDeletion
```
public LoadContext<E> setSoftDeletion(boolean softDeletion)
```
    Parameters:
    
    softDeletion - whether to use soft deletion when loading entities
  - getPrevQueries
```
public java.util.List<LoadContext.Query> getPrevQueries()
```
    Allows to execute query on a previous query result.
    
    Returns:
    
    editable list of previous queries
  - getQueryKey
```
public int getQueryKey()
```
    Returns:
    
    key of the current stack of sequential queries, which is unique for the current user session
  - setQueryKey
```
public LoadContext<E> setQueryKey(int queryKey)
```
    Parameters:
    
    queryKey - key of the current stack of sequential queries, which is unique for the current user session
  - getDbHints
```
public java.util.Map<java.lang.String,java.lang.Object> getDbHints()
```
    Returns:
    
    custom hints which can be used later during query construction
  - isLoadDynamicAttributes
```
public boolean isLoadDynamicAttributes()
```
    Returns:
    
    whether to load dynamic attributes
  - setLoadDynamicAttributes
```
public LoadContext<E> setLoadDynamicAttributes(boolean loadDynamicAttributes)
```
    Parameters:
    
    loadDynamicAttributes - whether to load dynamic attributes
  - isLoadPartialEntities
```
public boolean isLoadPartialEntities()
```
    Returns:
    
    whether to load partial entities. When true (which is by default), some local attributes can be unfetched according to setView(View).
    The state of View.loadPartialEntities is ignored when the view is passed to DataManager.
  - setLoadPartialEntities
```
public LoadContext<E> setLoadPartialEntities(boolean loadPartialEntities)
```
    Whether to load partial entities. When true (which is by default), some local attributes can be unfetched according to setView(View).
    The state of View.loadPartialEntities is ignored when the view is passed to DataManager.
  - copy
```
public LoadContext<?> copy()
```
    Creates a copy of this LoadContext instance.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class LoadContext<E extends Entity>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LoadContext

LoadContext

Method Detail

create

createQuery

getMetaClass

getQuery

setQuery

setQueryString

getView

setView

setView

getId

setId

isSoftDeletion

setSoftDeletion

getPrevQueries

getQueryKey

setQueryKey

getDbHints

isLoadDynamicAttributes

setLoadDynamicAttributes

isLoadPartialEntities

setLoadPartialEntities

copy

toString