LoadContext (Jmix-cuba 1.0 API)

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

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

public class LoadContext<E extends io.jmix.core.Entity>
extends io.jmix.core.LoadContext<E>

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);

Instead of using this class directly, consider fluent interface with the entry point in DataManager.load(Class).

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.

Field Summary

Fields
Modifier and Type Field and Description

protected java.util.List<LoadContext.Query> prevQueries
- Fields inherited from class io.jmix.core.LoadContext
  accessConstraints, fetchPlan, hints, id, idList, joinTransaction, loadPartialEntities, metaClass, query, queryKey

Fields
Modifier and Type	Field and Description
`protected java.util.List<LoadContext.Query>`	`prevQueries`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`LoadContext()`
	`LoadContext(java.lang.Class<E> javaClass)`
	`LoadContext(io.jmix.core.metamodel.model.MetaClass metaClass)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`LoadContext<?>`	`copy()` Creates a copy of this LoadContext instance.
`static <E extends io.jmix.core.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.List<LoadContext.Query>`	`getPrevQueries()` Allows to execute query on a previous query result.
`LoadContext.Query`	`getQuery()`
`io.jmix.core.FetchPlan`	`getView()`
`boolean`	`isLoadDynamicAttributes()` Returns true if the entity's dynamic attributes are loaded.
`boolean`	`isSoftDeletion()`
`LoadContext<E>`	`setAuthorizationRequired(boolean authorizationRequired)`
`LoadContext<E>`	`setFetchPlan(io.jmix.core.FetchPlan fetchPlan)`
`LoadContext<E>`	`setFetchPlan(java.lang.String fetchPlanName)`
`LoadContext<E>`	`setId(java.lang.Object id)`
`LoadContext<E>`	`setIds(java.util.Collection<?> ids)`
`LoadContext<E>`	`setJoinTransaction(boolean joinTransaction)`
`LoadContext<E>`	`setLoadDynamicAttributes(boolean loadDynamicAttributes)` Set to true to load the entity's dynamic attributes.
`LoadContext<E>`	`setLoadPartialEntities(boolean loadPartialEntities)`
`LoadContext<E>`	`setQuery(LoadContext.Query query)`
`LoadContext<E>`	`setQuery(io.jmix.core.LoadContext.Query query)`
`LoadContext<E>`	`setQueryKey(int queryKey)`
`LoadContext.Query`	`setQueryString(java.lang.String queryString)`
`LoadContext<E>`	`setSoftDeletion(boolean softDeletion)`
`LoadContext<E>`	`setView(io.jmix.core.FetchPlan fetchPlan)`
`LoadContext<E>`	`setView(java.lang.String fetchPlanName)` Deprecated. replaced by `setFetchPlan(String)`
`java.lang.String`	`toString()`

Methods inherited from class io.jmix.core.LoadContext
getAccessConstraints, getEntityMetaClass, getFetchPlan, getHints, getId, getIds, getPreviousQueries, getQueryKey, isJoinTransaction, isLoadPartialEntities, setAccessConstraints, setHint, setHints

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

- Field Detail
  - prevQueries
```
protected java.util.List<LoadContext.Query> prevQueries
```
- Constructor Detail
  - LoadContext
```
public LoadContext(io.jmix.core.metamodel.model.MetaClass metaClass)
```
    Parameters:
    
    metaClass - metaclass of the loaded entities
  - LoadContext
```
public LoadContext(java.lang.Class<E> javaClass)
```
    Parameters:
    
    javaClass - class of the loaded entities
  - LoadContext
```
protected LoadContext()
```
- Method Detail
  - create
```
public static <E extends io.jmix.core.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.
  - getQuery
```
public LoadContext.Query getQuery()
```
    Overrides:
    
    getQuery in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>
    
    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 io.jmix.core.DataLoadContext
    
    Overrides:
    
    setQueryString in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>
    
    Parameters:
    
    queryString - JPQL query string. Only named parameters are supported.
    
    Returns:
    
    query definition object
  - getView
```
public io.jmix.core.FetchPlan getView()
```
    Returns:
    
    view that is used for loading entities
  - setView
```
public LoadContext<E> setView(io.jmix.core.FetchPlan fetchPlan)
```
    Parameters:
    
    fetchPlan - view that is used for loading entities
    
    Returns:
    
    this instance for chaining
  - setView
```
@Deprecated
public LoadContext<E> setView(java.lang.String fetchPlanName)
```
    Deprecated. replaced by setFetchPlan(String)
  - setFetchPlan
```
public LoadContext<E> setFetchPlan(java.lang.String fetchPlanName)
```
    Parameters:
    
    fetchPlanName - fetch plan that is used for loading entities
    
    Returns:
    
    this instance for chaining
  - getPrevQueries
```
public java.util.List<LoadContext.Query> getPrevQueries()
```
    Allows to execute query on a previous query result.
    
    Returns:
    
    editable list of previous queries
  - setQuery
```
public LoadContext<E> setQuery(io.jmix.core.LoadContext.Query query)
```
    Overrides:
    
    setQuery in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>
  - setFetchPlan
```
public LoadContext<E> setFetchPlan(io.jmix.core.FetchPlan fetchPlan)
```
    Overrides:
    
    setFetchPlan in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>
  - setId
```
public LoadContext<E> setId(java.lang.Object id)
```
    Overrides:
    
    setId in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>
  - setIds
```
public LoadContext<E> setIds(java.util.Collection<?> ids)
```
    Overrides:
    
    setIds in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>
  - setSoftDeletion
```
public LoadContext<E> setSoftDeletion(boolean softDeletion)
```
    Parameters:
    
    softDeletion - whether to use soft deletion when loading entities
  - isSoftDeletion
```
public boolean isSoftDeletion()
```
    Returns:
    
    whether to use soft deletion when loading entities
  - setQueryKey
```
public LoadContext<E> setQueryKey(int queryKey)
```
    Overrides:
    
    setQueryKey in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>
  - isLoadDynamicAttributes
```
public boolean isLoadDynamicAttributes()
```
    Returns true if the entity's dynamic attributes are loaded.
  - setLoadDynamicAttributes
```
public LoadContext<E> setLoadDynamicAttributes(boolean loadDynamicAttributes)
```
    Set to true to load the entity's dynamic attributes. Dynamic attributes are not loaded by default.
  - setLoadPartialEntities
```
public LoadContext<E> setLoadPartialEntities(boolean loadPartialEntities)
```
    Overrides:
    
    setLoadPartialEntities in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>
  - setAuthorizationRequired
```
public LoadContext<E> setAuthorizationRequired(boolean authorizationRequired)
```
  - setJoinTransaction
```
public LoadContext<E> setJoinTransaction(boolean joinTransaction)
```
    Overrides:
    
    setJoinTransaction in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>
  - copy
```
public LoadContext<?> copy()
```
    Creates a copy of this LoadContext instance.
    
    Overrides:
    
    copy in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class io.jmix.core.LoadContext<E extends io.jmix.core.Entity>

Class LoadContext<E extends io.jmix.core.Entity>

Nested Class Summary

Field Summary

Fields inherited from class io.jmix.core.LoadContext

Constructor Summary

Method Summary

Methods inherited from class io.jmix.core.LoadContext

Methods inherited from class java.lang.Object

Field Detail

prevQueries

Constructor Detail

LoadContext

LoadContext

LoadContext

Method Detail

create

createQuery

getQuery

setQuery

setQueryString

getView

setView

setView

setFetchPlan

getPrevQueries

setQuery

setFetchPlan

setId

setIds

setSoftDeletion

isSoftDeletion

setQueryKey

isLoadDynamicAttributes

setLoadDynamicAttributes

setLoadPartialEntities

setAuthorizationRequired

setJoinTransaction

copy

toString