com.broadleafcommerce.tenant.domain

Class MultiTenantSiteCatalogImpl

java.lang.Object

com.broadleafcommerce.tenant.domain.MultiTenantSiteCatalogImpl

All Implemented Interfaces:

MultiTenantSiteCatalog, Serializable

@Embeddable
public class MultiTenantSiteCatalogImpl
extends Object
implements MultiTenantSiteCatalog

Author:

Phillip Verheyden (phillipuniverse), bpolster

See Also:

MultiTenantSiteCatalog}, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Character	excludeFromAdd
protected org.broadleafcommerce.common.site.domain.Catalog	implicitCatalog
protected String	mutabilityType
protected String	propagationMode
protected String	sandBoxName
protected String	status
protected String	targetStatus
protected Character	visibleAsAssigned

Constructor Summary

Constructors

Constructor and Description
MultiTenantSiteCatalogImpl()

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 MultiTenantSiteCatalog.getPropagationMode() is of type PropagationModeType.SANDBOX.
String	getStatus() The current status of the catalog.
String	getTargetStatus() The final status (MultiTenantSiteCatalog.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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mutabilityType

protected String mutabilityType

propagationMode

protected String propagationMode

status

protected String status

targetStatus

protected String targetStatus

sandBoxName

protected String sandBoxName

implicitCatalog

protected org.broadleafcommerce.common.site.domain.Catalog implicitCatalog

visibleAsAssigned

protected Character visibleAsAssigned

excludeFromAdd

protected Character excludeFromAdd

Constructor Detail

MultiTenantSiteCatalogImpl

public MultiTenantSiteCatalogImpl()

Method Detail

getMutabilityType

public AssignedCatalogType getMutabilityType()

Description copied from interface: MultiTenantSiteCatalog

Override the mutability of the associated catalog

Specified by:

getMutabilityType in interface MultiTenantSiteCatalog

Returns:

the mutability of the catalog

See Also:

MultiTenantCatalog#getAssignedCatalogType()

setMutabilityType

public void setMutabilityType(AssignedCatalogType mutabilityType)

Description copied from interface: MultiTenantSiteCatalog

Set the mutability of the associated catalog

Specified by:

setMutabilityType in interface MultiTenantSiteCatalog

Parameters:

mutabilityType - the mutability of the catalog

setPropagationMode

public void setPropagationMode(PropagationModeType mode)

Specified by:

setPropagationMode in interface MultiTenantSiteCatalog

getPropagationMode

public PropagationModeType getPropagationMode()

Description copied from interface: MultiTenantSiteCatalog

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).

Specified by:

getPropagationMode in interface MultiTenantSiteCatalog

Returns:

getStatus

public String getStatus()

Description copied from interface: MultiTenantSiteCatalog

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

Specified by:

getStatus in interface MultiTenantSiteCatalog

Returns:

setStatus

public void setStatus(String status)

Specified by:

setStatus in interface MultiTenantSiteCatalog

getTargetStatus

public String getTargetStatus()

Description copied from interface: MultiTenantSiteCatalog

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

Specified by:

getTargetStatus in interface MultiTenantSiteCatalog

Returns:

setTargetStatus

public void setTargetStatus(String targetStatus)

Specified by:

setTargetStatus in interface MultiTenantSiteCatalog

getSandBoxName

public String getSandBoxName()

Description copied from interface: MultiTenantSiteCatalog

The sandbox that should be used to hold propagated changes when MultiTenantSiteCatalog.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".

Specified by:

getSandBoxName in interface MultiTenantSiteCatalog

Returns:

setSandBoxName

public void setSandBoxName(String sandBoxName)

Specified by:

setSandBoxName in interface MultiTenantSiteCatalog

getImplicitCatalog

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

Description copied from interface: MultiTenantSiteCatalog

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

Specified by:

getImplicitCatalog in interface MultiTenantSiteCatalog

Returns:

setImplicitCatalog

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

Specified by:

setImplicitCatalog in interface MultiTenantSiteCatalog

getVisibleAsAssigned

public Boolean getVisibleAsAssigned()

Description copied from interface: MultiTenantSiteCatalog

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

Specified by:

getVisibleAsAssigned in interface MultiTenantSiteCatalog

Returns:

setVisibleAsAssigned

public void setVisibleAsAssigned(Boolean visibleAsAssigned)

Specified by:

setVisibleAsAssigned in interface MultiTenantSiteCatalog

getExcludeFromAdd

public Boolean getExcludeFromAdd()

Description copied from interface: MultiTenantSiteCatalog

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.

Specified by:

getExcludeFromAdd in interface MultiTenantSiteCatalog

Returns:

setExcludeFromAdd

public void setExcludeFromAdd(Boolean excludeFromAdd)

Specified by:

setExcludeFromAdd in interface MultiTenantSiteCatalog