Top Description Methods
org.eclipse.persistence.annotations

public @Interface Multitenant

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
Static Imports
java.lang.annotation.ElementType.TYPE, .RetentionPolicy.RUNTIME
Multitenant specifies that a given entity is shared amongst multiple tenants of a given application. The multitenant type specifies how the data for these entities are to be stored on the database for each tenant. Multitenant can be specified at the Entity or MappedSuperclass level.
Author
Guy Pelletier
Since
EclipseLink 2.3
See Also
org.eclipse.persistence.annotations.MultitenantType, org.eclipse.persistence.annotations.TenantDiscriminatorColumn, org.eclipse.persistence.annotations.TenantDiscriminatorColumns

Method Summary

Modifier and TypeMethod and Description
public boolean
includeCriteria()

(Optional) Indicate if the database requires the tenant criteria to be added to the SELECT, UPDATE, and DELETE queries.

public MultitenantType
value()

(Optional) Specify the multi-tenant strategy to use.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

includeCriteriaback to summary
public boolean includeCriteria()

(Optional) Indicate if the database requires the tenant criteria to be added to the SELECT, UPDATE, and DELETE queries. By default this is done but when set to false the queries will not be modified and it will be up to the application or database to ensure that the correct criteria is applied to all queries.

valueback to summary
public MultitenantType value()

(Optional) Specify the multi-tenant strategy to use.