com.broadleafcommerce.tenant.persistence

Interface MultiTenantStateManager

All Known Implementing Classes:

MultiTenantStateManagerImpl

public interface MultiTenantStateManager

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
void	endAllowMultiTenantDiscriminatorUpdate()
void	endExclusiveMultiTenantFilter()
void	endExplicitCatalogFilterMode() This ends the filtering of products exclusive to a catalog.
void	endInhibitPersistCascade()
void	endMultipleExplicitCatalogsFilterMode()
void	endSpecificCatalogFilterMode() Deprecated. this functionality does not work for derived catalogs and catalogs owned by template sites. The intent of this was to also include all super catalogs in the query but this only works for standard sites and catalogs within a standard site. Rather than using this mode, just ensure that you are not in isExplicitCatalogFilterMode() and the existing CatalogFilterEnabler will do the right thing.
Boolean	getExclusiveMultiTenantFilter()
boolean	isAllowMultiTenantDiscriminatorUpdate()
boolean	isExplicitCatalogFilterMode()
boolean	isInhibitPersistCascade()
boolean	isMultipleExplicitCatalogsFilterMode()
boolean	isSpecificCatalogFilterMode() Deprecated. this functionality does not work for derived catalogs and catalogs owned by template sites. The intent of this was to also include all super catalogs in the query but this only works for standard sites and catalogs within a standard site. Rather than using this mode, just ensure that you are not in isExplicitCatalogFilterMode() and the existing CatalogFilterEnabler will do the right thing.
void	startAllowMultiTenantDiscriminatorUpdate() The system will enforce not allowing the embeddableSiteDiscriminator.siteDiscriminator or the embeddableCatalogTenantDiscriminator.catalogDiscriminator values to be updated on an entity.
void	startExclusiveMultiTenantFilter()
void	startExplicitCatalogFilterMode() This is meant to mark the point when filtering should occur so that only exclusive catalog items are returned.
void	startInhibitPersistCascade()
void	startMultipleExplicitCatalogsFilterMode()
void	startSpecificCatalogFilterMode() Deprecated. this functionality does not work for derived catalogs and catalogs owned by template sites. The intent of this was to also include all super catalogs in the query but this only works for standard sites and catalogs within a standard site. Rather than using this mode, just ensure that you are not in isExplicitCatalogFilterMode() and the existing CatalogFilterEnabler will do the right thing.

Method Detail

startExclusiveMultiTenantFilter

void startExclusiveMultiTenantFilter()

endExclusiveMultiTenantFilter

void endExclusiveMultiTenantFilter()

getExclusiveMultiTenantFilter

Boolean getExclusiveMultiTenantFilter()

startSpecificCatalogFilterMode

@Deprecated
void startSpecificCatalogFilterMode()

Deprecated. this functionality does not work for derived catalogs and catalogs owned by template sites. The intent of this was to also include all super catalogs in the query but this only works for standard sites and catalogs within a standard site. Rather than using this mode, just ensure that you are not in isExplicitCatalogFilterMode() and the existing CatalogFilterEnabler will do the right thing.

endSpecificCatalogFilterMode

@Deprecated
void endSpecificCatalogFilterMode()

Deprecated. this functionality does not work for derived catalogs and catalogs owned by template sites. The intent of this was to also include all super catalogs in the query but this only works for standard sites and catalogs within a standard site. Rather than using this mode, just ensure that you are not in isExplicitCatalogFilterMode() and the existing CatalogFilterEnabler will do the right thing.

isSpecificCatalogFilterMode

@Deprecated
boolean isSpecificCatalogFilterMode()

Deprecated. this functionality does not work for derived catalogs and catalogs owned by template sites. The intent of this was to also include all super catalogs in the query but this only works for standard sites and catalogs within a standard site. Rather than using this mode, just ensure that you are not in isExplicitCatalogFilterMode() and the existing CatalogFilterEnabler will do the right thing.

startExplicitCatalogFilterMode

void startExplicitCatalogFilterMode()

This is meant to mark the point when filtering should occur so that only exclusive catalog items are returned. In other words, products should not be returned for parent catalogs.

endExplicitCatalogFilterMode

void endExplicitCatalogFilterMode()

This ends the filtering of products exclusive to a catalog.

isExplicitCatalogFilterMode

boolean isExplicitCatalogFilterMode()

startInhibitPersistCascade

void startInhibitPersistCascade()

isInhibitPersistCascade

boolean isInhibitPersistCascade()

endInhibitPersistCascade

void endInhibitPersistCascade()

startAllowMultiTenantDiscriminatorUpdate

void startAllowMultiTenantDiscriminatorUpdate()

The system will enforce not allowing the embeddableSiteDiscriminator.siteDiscriminator or the embeddableCatalogTenantDiscriminator.catalogDiscriminator values to be updated on an entity. Bounding a block of code with startAllowMultiTenantDiscriminatorUpdate() and endAllowMultiTenantDiscriminatorUpdate() will override this behavior and allow the value to be updated.

isAllowMultiTenantDiscriminatorUpdate

boolean isAllowMultiTenantDiscriminatorUpdate()

endAllowMultiTenantDiscriminatorUpdate

void endAllowMultiTenantDiscriminatorUpdate()

startMultipleExplicitCatalogsFilterMode

void startMultipleExplicitCatalogsFilterMode()

endMultipleExplicitCatalogsFilterMode

void endMultipleExplicitCatalogsFilterMode()

isMultipleExplicitCatalogsFilterMode

boolean isMultipleExplicitCatalogsFilterMode()