com.broadleafcommerce.tenant.domain

Interface MultiTenantSiteCatalog

All Superinterfaces:

Serializable

All Known Implementing Classes:

MultiTenantSiteCatalogImpl, WeaveSiteCatalogImpl

public interface MultiTenantSiteCatalog
extends Serializable

Represents additional fields weaved into SiteCatalogXrefImpl used by the multi-tenant module

Author:

Phillip Verheyden (phillipuniverse), bpolster

See Also:

WeaveSiteCatalogImpl}, SiteCatalogXrefImpl}, com.broadleafcommerce.tenant.domain.type.AssignedCatalogType}

Method Summary

Modifier and Type	Method and Description
Boolean	getExcludeFromAdd() Whether this catalog assignment should be visible in the admin during entity ADD operations.
org.broadleafcommerce.common.site.domain.Catalog	getImplicitCatalog() The catalog this reference implicitly serves.
AssignedCatalogType	getMutabilityType() Override the mutability of the associated catalog
PropagationModeType	getPropagationMode() Whether or not propagation into this catalog will occur into a sandbox, or will update the production record.
String	getSandBoxName() The sandbox that should be used to hold propagated changes when getPropagationMode() is of type PropagationModeType.SANDBOX.
String	getStatus() The current status of the catalog.
String	getTargetStatus() The final status (getStatus()) that the catalog should take upon completion of any creation steps.
Boolean	getVisibleAsAssigned() Whether this catalog assignment should be visible in the admin as being assigned.
void	setExcludeFromAdd(Boolean excludeFromAdd)
void	setImplicitCatalog(org.broadleafcommerce.common.site.domain.Catalog implicitCatalog)
void	setMutabilityType(AssignedCatalogType mutabilityType) Set the mutability of the associated catalog
void	setPropagationMode(PropagationModeType mode)
void	setSandBoxName(String sandBoxName)
void	setStatus(String status)
void	setTargetStatus(String targetStatus)
void	setVisibleAsAssigned(Boolean visibleAsAssigned)

Method Detail

getMutabilityType

AssignedCatalogType getMutabilityType()

Override the mutability of the associated catalog

Returns:

the mutability of the catalog

See Also:

MultiTenantCatalog#getAssignedCatalogType()

setMutabilityType

void setMutabilityType(AssignedCatalogType mutabilityType)

Set the mutability of the associated catalog

Parameters:

mutabilityType - the mutability of the catalog

getPropagationMode

PropagationModeType getPropagationMode()

Whether or not propagation into this catalog will occur into a sandbox, or will update the production record. If sandbox, propagation will stop here for this branch. This setting only applies for fully synced catalogs see AssignedCatalogType.SYNCED_COPY. This setting only applies to standard sites (SiteType.STANDARD).

Returns:

setPropagationMode

void setPropagationMode(PropagationModeType mode)

getStatus

String getStatus()

The current status of the catalog. Can be any of several statuses, including online, offline and syncing.

Returns:

setStatus

void setStatus(String status)

getTargetStatus

String getTargetStatus()

The final status (getStatus()) that the catalog should take upon completion of any creation steps.

Returns:

setTargetStatus

void setTargetStatus(String targetStatus)

getSandBoxName

String getSandBoxName()

The sandbox that should be used to hold propagated changes when getPropagationMode() is of type PropagationModeType.SANDBOX. If a sandbox is not provided here, a default sandbox is retrieved from the property "multitenant.propagation.sandbox.default.name".

Returns:

setSandBoxName

void setSandBoxName(String sandBoxName)

getImplicitCatalog

org.broadleafcommerce.common.site.domain.Catalog getImplicitCatalog()

The catalog this reference implicitly serves. Only used when this reference was created automatically to handle any standard site overrides for a assigned catalog.

Returns:

setImplicitCatalog

void setImplicitCatalog(org.broadleafcommerce.common.site.domain.Catalog implicitCatalog)

getVisibleAsAssigned

Boolean getVisibleAsAssigned()

Whether this catalog assignment should be visible in the admin as being assigned. This allows for hidden associations that the user would not see.

Returns:

setVisibleAsAssigned

void setVisibleAsAssigned(Boolean visibleAsAssigned)

getExcludeFromAdd

Boolean getExcludeFromAdd()

Whether this catalog assignment should be visible in the admin during entity ADD operations. If set to false, the user will not be able to select the associated catalog as a target for the ADD.

Returns:

setExcludeFromAdd

void setExcludeFromAdd(Boolean excludeFromAdd)