EntityViewMapping (Blazebit Persistence Entity-View API 1.2.1 API)

```
public interface EntityViewMapping
```
A mapping for an entity view type.

Since:

1.2.0

Author:

Christian Beikov

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.Map<java.lang.String,EntityViewAttributeMapping>`	`getAttributes()`	Returns the attribute mappings defined for this entity view mapping.
`java.util.Map<java.lang.String,EntityViewConstructorMapping>`	`getConstructors()`	Returns the constructor mappings defined for this entity view mapping.
`java.lang.Class<?>`	`getEntityClass()`	The JPA managed type class for which this entity view mapping is defined.
`java.lang.Class<?>`	`getEntityViewClass()`	The type represented by this entity view mapping.
`FlushMode`	`getFlushMode()`	Returns the flush mode to use for updates or `null` if the entity view should not be updatable.
`FlushStrategy`	`getFlushStrategy()`	Returns the flush strategy to use for updates or `null` if the entity view should not be updatable.
`EntityViewAttributeMapping`	`getIdAttribute()`	Returns the id attribute mapping of this entity view mapping or `null` if there is none.
`LockMode`	`getLockMode()`	Returns the lock mode to use for doing updates or `null` if the entity view should not be updatable.
`java.lang.String`	`getLockOwner()`	Returns the lock owner mapping relative to the JPA managed type of this entity view to use for updates or `null` if the entity view should not be updatable.
`java.lang.String`	`getName()`	Returns the name of the entity view, typically the simple type name.
`java.lang.reflect.Method`	`getPostCreateMethod()`	Returns the post create method or `null` if there is none.
`EntityViewAttributeMapping`	`getVersionAttribute()`	Returns the version attribute mapping of this entity view mapping or `null` if ther is none.
`boolean`	`isCreatable()`	Returns whether the entity view should be creatable i.e. support persist via `EntityViewManager.update(EntityManager, Object)`.
`boolean`	`isUpdatable()`	Returns whether the entity view should be updatable i.e. support updates via `EntityViewManager.update(EntityManager, Object)`.
`boolean`	`isValidatePersistability()`	Returns whether the persistability of an entity view should be validated i.e. check if an entity could be successfully persisted based on the settable attributes.
`void`	`setCreatable(boolean creatable)`	Set whether the entity view should be creatable.
`void`	`setEntityClass(java.lang.Class<?> entityClass)`	Set the JPA managed type class for this entity view mapping.
`void`	`setFlushMode(FlushMode flushMode)`	Set the flush mode to use for updates.
`void`	`setFlushStrategy(FlushStrategy flushStrategy)`	Set the flush strategy to use for updates.
`void`	`setIdAttribute(EntityViewAttributeMapping idAttribute)`	Set the id attribute mapping of this entity view mapping.
`void`	`setLockMode(LockMode lockMode)`	Set the lock mode to use for updates.
`void`	`setLockOwner(java.lang.String lockOwner)`	Set the lock owner mapping relative to the JPA managed type of this entity view.
`void`	`setName(java.lang.String name)`	Set the entity view name.
`void`	`setPostCreateMethod(java.lang.reflect.Method postCreateMethod)`	Sets the post create method.
`void`	`setUpdatable(boolean updatable)`	Set whether the entity view should be updatable.
`void`	`setValidatePersistability(boolean validatePersistability)`	Set whether the entity view should be validated regarding it's persistability.
`void`	`setVersionAttribute(EntityViewAttributeMapping versionAttribute)`	Set the version attribute mapping of this entity view mapping.

- Method Detail
  - getEntityViewClass
```
java.lang.Class<?> getEntityViewClass()
```
    The type represented by this entity view mapping.
    
    Returns:
    
    The entity view type
  - getEntityClass
```
java.lang.Class<?> getEntityClass()
```
    The JPA managed type class for which this entity view mapping is defined.
    
    Returns:
    
    The JPA managed type class
  - setEntityClass
```
void setEntityClass(java.lang.Class<?> entityClass)
```
    Set the JPA managed type class for this entity view mapping.
    
    Parameters:
    
    entityClass - The JPA managed type class
  - getName
```
java.lang.String getName()
```
    Returns the name of the entity view, typically the simple type name.
    
    Returns:
    
    The entity view name
  - setName
```
void setName(java.lang.String name)
```
    Set the entity view name.
    
    Parameters:
    
    name - The name
  - isUpdatable
```
boolean isUpdatable()
```
    Returns whether the entity view should be updatable i.e. support updates via EntityViewManager.update(EntityManager, Object).
    
    Returns:
    
    Whether the entity view should be updatable
  - setUpdatable
```
void setUpdatable(boolean updatable)
```
    Set whether the entity view should be updatable.
    
    Parameters:
    
    updatable - Whether the entity view should be updatable
  - getLockMode
```
LockMode getLockMode()
```
    Returns the lock mode to use for doing updates or null if the entity view should not be updatable.
    
    Returns:
    
    The lock mode for updates
  - setLockMode
```
void setLockMode(LockMode lockMode)
```
    Set the lock mode to use for updates.
    
    Parameters:
    
    lockMode - The lock mode
  - getLockOwner
```
java.lang.String getLockOwner()
```
    Returns the lock owner mapping relative to the JPA managed type of this entity view to use for updates or null if the entity view should not be updatable.
    
    Returns:
    
    The lock owner for updates
  - setLockOwner
```
void setLockOwner(java.lang.String lockOwner)
```
    Set the lock owner mapping relative to the JPA managed type of this entity view.
    
    Parameters:
    
    lockOwner - The lock owner mapping
  - getFlushMode
```
FlushMode getFlushMode()
```
    Returns the flush mode to use for updates or null if the entity view should not be updatable.
    
    Returns:
    
    The flush mode for updates
  - setFlushMode
```
void setFlushMode(FlushMode flushMode)
```
    Set the flush mode to use for updates.
    
    Parameters:
    
    flushMode - The flush mode
  - getFlushStrategy
```
FlushStrategy getFlushStrategy()
```
    Returns the flush strategy to use for updates or null if the entity view should not be updatable.
    
    Returns:
    
    The flush strategy for updates
  - setFlushStrategy
```
void setFlushStrategy(FlushStrategy flushStrategy)
```
    Set the flush strategy to use for updates.
    
    Parameters:
    
    flushStrategy - The flush strategy
  - getPostCreateMethod
```
java.lang.reflect.Method getPostCreateMethod()
```
    Returns the post create method or null if there is none.
    
    Returns:
    
    The post create method
  - setPostCreateMethod
```
void setPostCreateMethod(java.lang.reflect.Method postCreateMethod)
```
    Sets the post create method.
    
    Parameters:
    
    postCreateMethod - The method
  - isCreatable
```
boolean isCreatable()
```
    Returns whether the entity view should be creatable i.e. support persist via EntityViewManager.update(EntityManager, Object).
    
    Returns:
    
    Whether the entity view should be creatable
  - setCreatable
```
void setCreatable(boolean creatable)
```
    Set whether the entity view should be creatable.
    
    Parameters:
    
    creatable - Whether the entity view should be creatable
  - isValidatePersistability
```
boolean isValidatePersistability()
```
    Returns whether the persistability of an entity view should be validated i.e. check if an entity could be successfully persisted based on the settable attributes.
    
    Returns:
    
    Whether the persistability of an entity view should be validated
  - setValidatePersistability
```
void setValidatePersistability(boolean validatePersistability)
```
    Set whether the entity view should be validated regarding it's persistability.
    
    Parameters:
    
    validatePersistability - Whether the entity view should be validated regarding it's persistability
  - getIdAttribute
```
EntityViewAttributeMapping getIdAttribute()
```
    Returns the id attribute mapping of this entity view mapping or null if there is none.
    
    Returns:
    
    The id attribute mapping or null if there is none
  - setIdAttribute
```
void setIdAttribute(EntityViewAttributeMapping idAttribute)
```
    Set the id attribute mapping of this entity view mapping. Note that the attribute must be one of the attributes as given by getAttributes() or null.
    
    Parameters:
    
    idAttribute - The id attribute mapping
  - getVersionAttribute
```
EntityViewAttributeMapping getVersionAttribute()
```
    Returns the version attribute mapping of this entity view mapping or null if ther is none.
    
    Returns:
    
    The version attribute mapping or null if there is none
  - setVersionAttribute
```
void setVersionAttribute(EntityViewAttributeMapping versionAttribute)
```
    Set the version attribute mapping of this entity view mapping. Note that the attribute must be one of the attributes as given by getAttributes() or null.
    
    Parameters:
    
    versionAttribute - The version attribute mapping
  - getAttributes
```
java.util.Map<java.lang.String,EntityViewAttributeMapping> getAttributes()
```
    Returns the attribute mappings defined for this entity view mapping.
    
    Returns:
    
    The defined attribute mappings
  - getConstructors
```
java.util.Map<java.lang.String,EntityViewConstructorMapping> getConstructors()
```
    Returns the constructor mappings defined for this entity view mapping.
    
    Returns:
    
    The defined constructor mappings

Interface EntityViewMapping

Method Summary

Method Detail

getEntityViewClass

getEntityClass

setEntityClass

getName

setName

isUpdatable

setUpdatable

getLockMode

setLockMode

getLockOwner

setLockOwner

getFlushMode

setFlushMode

getFlushStrategy

setFlushStrategy

getPostCreateMethod

setPostCreateMethod

isCreatable

setCreatable

isValidatePersistability

setValidatePersistability

getIdAttribute

setIdAttribute

getVersionAttribute

setVersionAttribute

getAttributes

getConstructors