com.broadleafcommerce.tenant.domain

Interface CatalogDerivedCatalogXref

All Superinterfaces:

Serializable

All Known Implementing Classes:

CatalogDerivedCatalogXrefImpl

public interface CatalogDerivedCatalogXref
extends Serializable

Defines the explicit join between a Catalog and other Catalogs from which it is derived

Author:

bpolster

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.common.site.domain.Catalog	getCatalog() Represents the current catalog which may be derived from one or more other catalogs.
DeploymentStatus	getDeploymentStatus() Gets the current DeploymentStatus for the given derived catalog.
org.broadleafcommerce.common.site.domain.Catalog	getDerivedFromCatalog() Returns one of the catalogs which the catalog is derived from.
Long	getId() Primary key of this xref.
Long	getInheritedFromCatalog() If this item was automatically set by the system, note the catalog that drove it.
DerivedFromType	getMutabilityType() Dictates whether the derived items can be edited or not within the catalog.
Boolean	getVisible() Whether or not this record is visible in the derived catalog UI.
void	setCatalog(org.broadleafcommerce.common.site.domain.Catalog catalog) Sets the catalog which may be derived from one or more other catalogs.
void	setDeloymentStatus(DeploymentStatus deploymentStatus) Sets the DeploymentStatus
void	setDerivedFromCatalog(org.broadleafcommerce.common.site.domain.Catalog derivedFromCatalog) Sets one of the catalogs from which this catalog is derived.
void	setId(Long id) Sets the primary key for this xref.
void	setInheritedFromCatalog(Long inheritedFromCatalog)
void	setMutabilityType(DerivedFromType mutabilityType) Sets whether the derived items can be edited or not within the catalog.
void	setVisible(Character visible)

Method Detail

getId

Long getId()

Primary key of this xref.

Returns:

setId

void setId(Long id)

Sets the primary key for this xref.

Parameters:

id -

getCatalog

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

Represents the current catalog which may be derived from one or more other catalogs.

Returns:

setCatalog

void setCatalog(org.broadleafcommerce.common.site.domain.Catalog catalog)

Sets the catalog which may be derived from one or more other catalogs.

Parameters:

catalog -

getDerivedFromCatalog

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

Returns one of the catalogs which the catalog is derived from.

Returns:

setDerivedFromCatalog

void setDerivedFromCatalog(org.broadleafcommerce.common.site.domain.Catalog derivedFromCatalog)

Sets one of the catalogs from which this catalog is derived.

Parameters:

derivedFromCatalog -

getMutabilityType

DerivedFromType getMutabilityType()

Dictates whether the derived items can be edited or not within the catalog.

Returns:

the mutability of the derived catalog items

setMutabilityType

void setMutabilityType(DerivedFromType mutabilityType)

Sets whether the derived items can be edited or not within the catalog.

Parameters:

mutabilityType - the mutability of the catalog

getDeploymentStatus

DeploymentStatus getDeploymentStatus()

Gets the current DeploymentStatus for the given derived catalog. Note that this status is only relevant for catalogs that require propagation.

Returns:

the current DeploymentStatus, if any

setDeloymentStatus

void setDeloymentStatus(DeploymentStatus deploymentStatus)

Sets the DeploymentStatus

Parameters:

deploymentStatus -

getVisible

Boolean getVisible()

Whether or not this record is visible in the derived catalog UI.

Returns:

setVisible

void setVisible(Character visible)

getInheritedFromCatalog

Long getInheritedFromCatalog()

If this item was automatically set by the system, note the catalog that drove it. This normally occurs when a derived catalog automatically inherits a REFERENCE catalog from its parent.

Returns:

setInheritedFromCatalog

void setInheritedFromCatalog(Long inheritedFromCatalog)