Entity (EclipseLink 2.6.9, API Reference)

```
public interface Entity
```
JPA scripting API implementation.

Author:

Guy Pelletier

Since:

EclipseLink 2.5.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Array`	`addArray()`
`AssociationOverride`	`addAssociationOverride()`
`AttributeOverride`	`addAttributeOverride()`
`Basic`	`addBasic()`
`CacheIndex`	`addCacheIndex()`
`Convert`	`addConvert()`
`Converter`	`addConverter()`
`ElementCollection`	`addElementCollection()`
`Embedded`	`addEmbedded()`
`EntityListener`	`addEntityListener()`
`FetchGroup`	`addFetchGroup()`
`Id`	`addId()`
`Index`	`addIndex()`
`ManyToMany`	`addManyToMany()`
`ManyToOne`	`addManyToOne()`
`NamedNativeQuery`	`addNamedNativeQuery()`
`NamedPlsqlStoredFunctionQuery`	`addNamedPLSQLStoredFunctionQuery()`
`NamedPlsqlStoredProcedureQuery`	`addNamedPLSQLStoredProcedureQuery()`
`NamedQuery`	`addNamedQuery()`
`NamedStoredFunctionQuery`	`addNamedStoredFunctionQuery()`
`NamedStoredProcedureQuery`	`addNamedStoredProcedureQuery()`
`ObjectTypeConverter`	`addObjectTypeConverter()`
`OneToMany`	`addOneToMany()`
`OneToOne`	`addOneToOne()`
`OracleArray`	`addOracleArray()`
`OracleObject`	`addOracleObject()`
`PlsqlRecord`	`addPlsqlRecord()`
`PlsqlTable`	`addPlsqlTable()`
`PrimaryKeyJoinColumn`	`addPrimaryKeyJoinColumn()`
`Property`	`addProperty()`
`SecondaryTable`	`addSecondaryTable()`
`SqlResultSetMapping`	`addSqlResultSetMapping()`
`StructConverter`	`addStructConverter()`
`Structure`	`addStructure()`
`Transformation`	`addTransformation()`
`Transient`	`addTransient()`
`TypeConverter`	`addTypeConverter()`
`VariableOneToOne`	`addVariableOneToOne()`
`Version`	`addVersion()`
`Entity`	`setAccess(java.lang.String access)`
`AccessMethods`	`setAccessMethods()`
`AdditionalCriteria`	`setAdditionalCriteria()`
`Cache`	`setCache()`
`Entity`	`setCacheable(java.lang.Boolean cacheable)`
`CacheInterceptor`	`setCacheInterceptor()`
`Entity`	`setCascadeOnDelete(java.lang.Boolean cascadeOnDelete)`
`ChangeTracking`	`setChangeTracking()`
`Entity`	`setClass(java.lang.String cls)`
`Entity`	`setClassExtractor(java.lang.String classExtractor)`
`CloneCopyPolicy`	`setCloneCopyPolicy()`
`CopyPolicy`	`setCopyPolicy()`
`Entity`	`setCustomizer(java.lang.String customizer)`
`DiscriminatorColumn`	`setDiscriminatorColumn()`
`Entity`	`setDiscriminatorValue(java.lang.String discriminatorValue)`
`EmbeddedId`	`setEmbeddedId()`
`Entity`	`setExcludeDefaultListeners(java.lang.Boolean excludeDefaultListeners)`
`Entity`	`setExcludeDefaultMappings(java.lang.Boolean excludeDefaultMappings)`
`Entity`	`setExcludeSuperclassListeners(java.lang.Boolean excludeSuperclassListeners)`
`Entity`	`setExistenceChecking(java.lang.String existenceChecking)`
`HashPartitioning`	`setHashPartitioning()`
`Entity`	`setIdClass(java.lang.String idClass)`
`Inheritance`	`setInheritance()`
`InstantiationCopyPolicy`	`setInstantiationCopyPolicy()`
`Entity`	`setMetadataComplete(java.lang.Boolean metadataComplete)`
`Multitenant`	`setMultitenant()`
`Entity`	`setName(java.lang.String name)`
`NoSql`	`setNoSql()`
`OptimisticLocking`	`setOptimisticLocking()`
`Entity`	`setParentClass(java.lang.String parentClass)`
`Partitioning`	`setPartitioning()`
`PinnedPartitioning`	`setPinnedPartitioning()`
`Entity`	`setPostLoad(java.lang.String methodName)`
`Entity`	`setPostPersist(java.lang.String methodName)`
`Entity`	`setPostRemove(java.lang.String methodName)`
`Entity`	`setPostUpdate(java.lang.String methodName)`
`Entity`	`setPrePersist(java.lang.String methodName)`
`Entity`	`setPreRemove(java.lang.String methodName)`
`Entity`	`setPreUpdate(java.lang.String methodName)`
`PrimaryKey`	`setPrimaryKey()`
`ForeignKey`	`setPrimaryKeyForeignKey()`
`QueryRedirectors`	`setQueryRedirectors()`
`RangePartitioning`	`setRangePartitioning()`
`Entity`	`setReadOnly(java.lang.Boolean readOnly)`
`ReplicationPartitioning`	`setReplicationPartitioning()`
`RoundRobinPartitioning`	`setRoundRobinPartitioning()`
`SequenceGenerator`	`setSequenceGenerator()`
`Struct`	`setStruct()`
`Table`	`setTable()`
`TableGenerator`	`setTableGenerator()`
`UnionPartitioning`	`setUnionPartitioning()`
`UuidGenerator`	`setUuidGenerator()`
`ValuePartitioning`	`setValuePartitioning()`

Method Detail

addArray
```
Array addArray()
```

addAssociationOverride

AssociationOverride addAssociationOverride()

addAttributeOverride

AttributeOverride addAttributeOverride()

addBasic
```
Basic addBasic()
```

addCacheIndex
```
CacheIndex addCacheIndex()
```

addConvert
```
Convert addConvert()
```

addConverter
```
Converter addConverter()
```

addElementCollection

ElementCollection addElementCollection()

addEntityListener
```
EntityListener addEntityListener()
```

addEmbedded
```
Embedded addEmbedded()
```

addFetchGroup
```
FetchGroup addFetchGroup()
```

addId
```
Id addId()
```

addIndex
```
Index addIndex()
```

addManyToMany
```
ManyToMany addManyToMany()
```

addManyToOne
```
ManyToOne addManyToOne()
```

addNamedNativeQuery
```
NamedNativeQuery addNamedNativeQuery()
```

addNamedPLSQLStoredFunctionQuery

NamedPlsqlStoredFunctionQuery addNamedPLSQLStoredFunctionQuery()

addNamedPLSQLStoredProcedureQuery

NamedPlsqlStoredProcedureQuery addNamedPLSQLStoredProcedureQuery()

addNamedQuery
```
NamedQuery addNamedQuery()
```

addNamedStoredFunctionQuery

NamedStoredFunctionQuery addNamedStoredFunctionQuery()

addNamedStoredProcedureQuery

NamedStoredProcedureQuery addNamedStoredProcedureQuery()

addObjectTypeConverter

ObjectTypeConverter addObjectTypeConverter()

addOneToMany
```
OneToMany addOneToMany()
```

addOneToOne
```
OneToOne addOneToOne()
```

addOracleArray
```
OracleArray addOracleArray()
```

addOracleObject
```
OracleObject addOracleObject()
```

addPlsqlRecord
```
PlsqlRecord addPlsqlRecord()
```

addPlsqlTable
```
PlsqlTable addPlsqlTable()
```

addPrimaryKeyJoinColumn

PrimaryKeyJoinColumn addPrimaryKeyJoinColumn()

addProperty
```
Property addProperty()
```

addSecondaryTable
```
SecondaryTable addSecondaryTable()
```

addSqlResultSetMapping

SqlResultSetMapping addSqlResultSetMapping()

addStructConverter
```
StructConverter addStructConverter()
```

addStructure
```
Structure addStructure()
```

addTransformation
```
Transformation addTransformation()
```

addTransient
```
Transient addTransient()
```

addTypeConverter
```
TypeConverter addTypeConverter()
```

addVariableOneToOne
```
VariableOneToOne addVariableOneToOne()
```

addVersion
```
Version addVersion()
```

setAccess

Entity setAccess(java.lang.String access)

setAccessMethods
```
AccessMethods setAccessMethods()
```

setAdditionalCriteria

AdditionalCriteria setAdditionalCriteria()

setCache
```
Cache setCache()
```

setCacheable

Entity setCacheable(java.lang.Boolean cacheable)

setCacheInterceptor
```
CacheInterceptor setCacheInterceptor()
```

setCascadeOnDelete

Entity setCascadeOnDelete(java.lang.Boolean cascadeOnDelete)

setChangeTracking
```
ChangeTracking setChangeTracking()
```

setClass
```
Entity setClass(java.lang.String cls)
```

setClassExtractor

Entity setClassExtractor(java.lang.String classExtractor)

setCloneCopyPolicy
```
CloneCopyPolicy setCloneCopyPolicy()
```

setCopyPolicy
```
CopyPolicy setCopyPolicy()
```

setCustomizer

Entity setCustomizer(java.lang.String customizer)

setDiscriminatorColumn

DiscriminatorColumn setDiscriminatorColumn()

setDiscriminatorValue

Entity setDiscriminatorValue(java.lang.String discriminatorValue)

setEmbeddedId
```
EmbeddedId setEmbeddedId()
```

setExcludeDefaultListeners

Entity setExcludeDefaultListeners(java.lang.Boolean excludeDefaultListeners)

setExcludeDefaultMappings

Entity setExcludeDefaultMappings(java.lang.Boolean excludeDefaultMappings)

setExcludeSuperclassListeners

Entity setExcludeSuperclassListeners(java.lang.Boolean excludeSuperclassListeners)

setExistenceChecking

Entity setExistenceChecking(java.lang.String existenceChecking)

setHashPartitioning
```
HashPartitioning setHashPartitioning()
```

setIdClass

Entity setIdClass(java.lang.String idClass)

setInheritance
```
Inheritance setInheritance()
```

setInstantiationCopyPolicy

InstantiationCopyPolicy setInstantiationCopyPolicy()

setMetadataComplete

Entity setMetadataComplete(java.lang.Boolean metadataComplete)

setMultitenant
```
Multitenant setMultitenant()
```

setName
```
Entity setName(java.lang.String name)
```

setNoSql
```
NoSql setNoSql()
```

setOptimisticLocking

OptimisticLocking setOptimisticLocking()

setParentClass

Entity setParentClass(java.lang.String parentClass)

setPartitioning
```
Partitioning setPartitioning()
```

setPinnedPartitioning

PinnedPartitioning setPinnedPartitioning()

setPostLoad

Entity setPostLoad(java.lang.String methodName)

setPostPersist

Entity setPostPersist(java.lang.String methodName)

setPostRemove

Entity setPostRemove(java.lang.String methodName)

setPostUpdate

Entity setPostUpdate(java.lang.String methodName)

setPrePersist

Entity setPrePersist(java.lang.String methodName)

setPreRemove

Entity setPreRemove(java.lang.String methodName)

setPreUpdate

Entity setPreUpdate(java.lang.String methodName)

setPrimaryKey
```
PrimaryKey setPrimaryKey()
```

setPrimaryKeyForeignKey
```
ForeignKey setPrimaryKeyForeignKey()
```

setQueryRedirectors
```
QueryRedirectors setQueryRedirectors()
```

setRangePartitioning

RangePartitioning setRangePartitioning()

setReadOnly

Entity setReadOnly(java.lang.Boolean readOnly)

setReplicationPartitioning

ReplicationPartitioning setReplicationPartitioning()

setRoundRobinPartitioning

RoundRobinPartitioning setRoundRobinPartitioning()

setSequenceGenerator

SequenceGenerator setSequenceGenerator()

setStruct
```
Struct setStruct()
```

setTable
```
Table setTable()
```

setTableGenerator
```
TableGenerator setTableGenerator()
```

setUnionPartitioning

UnionPartitioning setUnionPartitioning()

setUuidGenerator
```
UuidGenerator setUuidGenerator()
```

setValuePartitioning

ValuePartitioning setValuePartitioning()

Interface Entity

Method Summary

Method Detail

addArray

addAssociationOverride

addAttributeOverride

addBasic

addCacheIndex

addConvert

addConverter

addElementCollection

addEntityListener

addEmbedded

addFetchGroup

addId

addIndex

addManyToMany

addManyToOne

addNamedNativeQuery

addNamedPLSQLStoredFunctionQuery

addNamedPLSQLStoredProcedureQuery

addNamedQuery

addNamedStoredFunctionQuery

addNamedStoredProcedureQuery

addObjectTypeConverter

addOneToMany

addOneToOne

addOracleArray

addOracleObject

addPlsqlRecord

addPlsqlTable

addPrimaryKeyJoinColumn

addProperty

addSecondaryTable

addSqlResultSetMapping

addStructConverter

addStructure

addTransformation

addTransient

addTypeConverter

addVariableOneToOne

addVersion

setAccess

setAccessMethods

setAdditionalCriteria

setCache

setCacheable

setCacheInterceptor

setCascadeOnDelete

setChangeTracking

setClass

setClassExtractor

setCloneCopyPolicy

setCopyPolicy

setCustomizer

setDiscriminatorColumn

setDiscriminatorValue

setEmbeddedId

setExcludeDefaultListeners

setExcludeDefaultMappings

setExcludeSuperclassListeners

setExistenceChecking

setHashPartitioning

setIdClass

setInheritance

setInstantiationCopyPolicy

setMetadataComplete

setMultitenant

setName

setNoSql

setOptimisticLocking

setParentClass

setPartitioning

setPinnedPartitioning

setPostLoad

setPostPersist

setPostRemove

setPostUpdate

setPrePersist

setPreRemove