org.eclipse.jpt.jpa.eclipselink.core.context
Interface EclipseLinkMultitenancy2_3

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model

All Known Subinterfaces:

EclipseLinkJavaMultitenancy2_3, EclipseLinkOrmMultitenancy2_3

public interface EclipseLinkMultitenancy2_3
extends JpaContextModel

EclipseLink multitenancy

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

3.1

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static boolean	DEFAULT_INCLUDE_CRITERIA
static String	DEFAULT_INCLUDE_CRITERIA_PROPERTY
static String	DEFAULT_MULTITENANT_PROPERTY
static String	DEFAULT_TENANT_DISCRIMINATOR_COLUMNS_LIST
static EclipseLinkMultitenantType2_3	DEFAULT_TYPE
static String	DEFAULT_TYPE_PROPERTY
static String	SPECIFIED_INCLUDE_CRITERIA_PROPERTY
static String	SPECIFIED_MULTITENANT_PROPERTY
static String	SPECIFIED_TENANT_DISCRIMINATOR_COLUMNS_ALLOWED_PROPERTY
static String	SPECIFIED_TENANT_DISCRIMINATOR_COLUMNS_LIST
static String	SPECIFIED_TYPE_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

EclipseLinkSpecifiedTenantDiscriminatorColumn2_3	addSpecifiedTenantDiscriminatorColumn() Add a specified tenant discriminator column and return the object representing it.
EclipseLinkSpecifiedTenantDiscriminatorColumn2_3	addSpecifiedTenantDiscriminatorColumn(int index) Add a specified tenant discriminator column and return the object representing it.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends EclipseLinkVirtualTenantDiscriminatorColumn2_3>	getDefaultTenantDiscriminatorColumns() Return a list iterable of the default tenant discriminator columns.
int	getDefaultTenantDiscriminatorColumnsSize() Return the number of default tenant discriminator columns.
EclipseLinkMultitenantType2_3	getDefaultType()
Boolean	getSpecifiedIncludeCriteria()
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends EclipseLinkSpecifiedTenantDiscriminatorColumn2_3>	getSpecifiedTenantDiscriminatorColumns() Return a list iterable of the specified tenant discriminator columns.
int	getSpecifiedTenantDiscriminatorColumnsSize() Return the number of specified tenant discriminator columns.
EclipseLinkMultitenantType2_3	getSpecifiedType()
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends EclipseLinkTenantDiscriminatorColumn2_3>	getTenantDiscriminatorColumns() Return the tenant discriminator columns whether specified or default.
int	getTenantDiscriminatorColumnsSize() Return the number of tenant discriminator columns, whether specified and default.
EclipseLinkMultitenantType2_3	getType() This is the combination of defaultType and specifiedType.
boolean	hasSpecifiedTenantDiscriminatorColumns() Return whether there are any specified tenant discriminator columns.
boolean	isDefaultIncludeCriteria()
boolean	isDefaultMultitenant()
boolean	isIncludeCriteria() This is the combination of defaultIncludeCriteria and specifiedIncludeCriteria.
boolean	isMultitenant()
boolean	isSpecifiedMultitenant()
void	moveSpecifiedTenantDiscriminatorColumn(int targetIndex, int sourceIndex) Move the specified tenant discriminator column from the source index to the target index.
void	removeSpecifiedTenantDiscriminatorColumn(EclipseLinkSpecifiedTenantDiscriminatorColumn2_3 tenantDiscriminatorColumn) Remove the specified tenant discriminator column.
void	removeSpecifiedTenantDiscriminatorColumn(int index) Remove the specified tenant discriminator column at the index.
void	setSpecifiedIncludeCriteria(Boolean includeCriteria)
void	setSpecifiedMultitenant(boolean isMultitenant)
void	setSpecifiedType(EclipseLinkMultitenantType2_3 type)
boolean	specifiedTenantDiscriminatorColumnsAllowed() Return whether a TenantDiscriminatorColumn is allowed for this type mapping.
boolean	usesPrimaryKeyTenantDiscriminatorColumns() Return true if any of the tenant discriminator columns (specified or default) have the primaryKey option set to true

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextModel

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaModel

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Field Detail

DEFAULT_MULTITENANT_PROPERTY

static final String DEFAULT_MULTITENANT_PROPERTY

See Also:

Constant Field Values

SPECIFIED_MULTITENANT_PROPERTY

static final String SPECIFIED_MULTITENANT_PROPERTY

See Also:

Constant Field Values

SPECIFIED_TYPE_PROPERTY

static final String SPECIFIED_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_TYPE_PROPERTY

static final String DEFAULT_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_TYPE

static final EclipseLinkMultitenantType2_3 DEFAULT_TYPE

SPECIFIED_INCLUDE_CRITERIA_PROPERTY

static final String SPECIFIED_INCLUDE_CRITERIA_PROPERTY

See Also:

Constant Field Values

DEFAULT_INCLUDE_CRITERIA_PROPERTY

static final String DEFAULT_INCLUDE_CRITERIA_PROPERTY

See Also:

Constant Field Values

DEFAULT_INCLUDE_CRITERIA

static final boolean DEFAULT_INCLUDE_CRITERIA

See Also:

Constant Field Values

SPECIFIED_TENANT_DISCRIMINATOR_COLUMNS_LIST

static final String SPECIFIED_TENANT_DISCRIMINATOR_COLUMNS_LIST

See Also:

Constant Field Values

DEFAULT_TENANT_DISCRIMINATOR_COLUMNS_LIST

static final String DEFAULT_TENANT_DISCRIMINATOR_COLUMNS_LIST

See Also:

Constant Field Values

SPECIFIED_TENANT_DISCRIMINATOR_COLUMNS_ALLOWED_PROPERTY

static final String SPECIFIED_TENANT_DISCRIMINATOR_COLUMNS_ALLOWED_PROPERTY

See Also:

Constant Field Values

Method Detail

isMultitenant

boolean isMultitenant()

isDefaultMultitenant

boolean isDefaultMultitenant()

isSpecifiedMultitenant

boolean isSpecifiedMultitenant()

setSpecifiedMultitenant

void setSpecifiedMultitenant(boolean isMultitenant)

getType

EclipseLinkMultitenantType2_3 getType()

This is the combination of defaultType and specifiedType. If getSpecifiedType() returns null, then return getDefaultType()

getSpecifiedType

EclipseLinkMultitenantType2_3 getSpecifiedType()

setSpecifiedType

void setSpecifiedType(EclipseLinkMultitenantType2_3 type)

getDefaultType

EclipseLinkMultitenantType2_3 getDefaultType()

isIncludeCriteria

boolean isIncludeCriteria()

This is the combination of defaultIncludeCriteria and specifiedIncludeCriteria. If getSpecifiedIncludeCriteria() returns null, then return isDefaultIncludeCriteria()

getSpecifiedIncludeCriteria

Boolean getSpecifiedIncludeCriteria()

setSpecifiedIncludeCriteria

void setSpecifiedIncludeCriteria(Boolean includeCriteria)

isDefaultIncludeCriteria

boolean isDefaultIncludeCriteria()

getTenantDiscriminatorColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends EclipseLinkTenantDiscriminatorColumn2_3> getTenantDiscriminatorColumns()

Return the tenant discriminator columns whether specified or default.

getTenantDiscriminatorColumnsSize

int getTenantDiscriminatorColumnsSize()

Return the number of tenant discriminator columns, whether specified and default.

getSpecifiedTenantDiscriminatorColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends EclipseLinkSpecifiedTenantDiscriminatorColumn2_3> getSpecifiedTenantDiscriminatorColumns()

Return a list iterable of the specified tenant discriminator columns. This will not be null.

getSpecifiedTenantDiscriminatorColumnsSize

int getSpecifiedTenantDiscriminatorColumnsSize()

Return the number of specified tenant discriminator columns.

hasSpecifiedTenantDiscriminatorColumns

boolean hasSpecifiedTenantDiscriminatorColumns()

Return whether there are any specified tenant discriminator columns.

addSpecifiedTenantDiscriminatorColumn

EclipseLinkSpecifiedTenantDiscriminatorColumn2_3 addSpecifiedTenantDiscriminatorColumn()

Add a specified tenant discriminator column and return the object representing it.

addSpecifiedTenantDiscriminatorColumn

EclipseLinkSpecifiedTenantDiscriminatorColumn2_3 addSpecifiedTenantDiscriminatorColumn(int index)

Add a specified tenant discriminator column and return the object representing it.

removeSpecifiedTenantDiscriminatorColumn

void removeSpecifiedTenantDiscriminatorColumn(EclipseLinkSpecifiedTenantDiscriminatorColumn2_3 tenantDiscriminatorColumn)

Remove the specified tenant discriminator column.

removeSpecifiedTenantDiscriminatorColumn

void removeSpecifiedTenantDiscriminatorColumn(int index)

Remove the specified tenant discriminator column at the index.

moveSpecifiedTenantDiscriminatorColumn

void moveSpecifiedTenantDiscriminatorColumn(int targetIndex,
                                            int sourceIndex)

Move the specified tenant discriminator column from the source index to the target index.

getDefaultTenantDiscriminatorColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends EclipseLinkVirtualTenantDiscriminatorColumn2_3> getDefaultTenantDiscriminatorColumns()

Return a list iterable of the default tenant discriminator columns. This will not be null. If there are specified tenant discriminator columns then there will be no default tenant discriminator columns.

getDefaultTenantDiscriminatorColumnsSize

int getDefaultTenantDiscriminatorColumnsSize()

Return the number of default tenant discriminator columns.

specifiedTenantDiscriminatorColumnsAllowed

boolean specifiedTenantDiscriminatorColumnsAllowed()

Return whether a TenantDiscriminatorColumn is allowed for this type mapping. It is allowed if it is a mapped-superclass, the root entity in the inheritance hierarchy, or the inheritance strategy is table-per-class

usesPrimaryKeyTenantDiscriminatorColumns

boolean usesPrimaryKeyTenantDiscriminatorColumns()

Return true if any of the tenant discriminator columns (specified or default) have the primaryKey option set to true