Class Catalog
java.lang.Object
com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog
- All Implemented Interfaces:
ContextStateAware
Represents a catalog node in an overall catalog tree.
- Author:
- Jeff Fischer
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
A subset ofTracking
information to expose the context state for this object.DefaultCurrency
associated with this catalog, or null.Whether or not this catalog is hidden from selection in the admin.getId()
The context id, which is a separate identifier from the database primary key.getLevel()
The level for a catalog in the tree going from least (root nodes) to highest (leaf nodes).Allows for segmenting catalogs via their locale, and encodes the assumption of the defaulted region for all items contained within it.getName()
The name for the catalogSoft reference to the application contextId that owns this catalog.The parent nodes for this catalog, including additional mutability information.Soft reference to the vendor associated with this catalog.int
hashCode()
void
setContextState
(ContextState contextState) A subset ofTracking
information to expose the context state for this object.void
setDefaultCurrency
(Currency defaultCurrency) DefaultCurrency
associated with this catalog, or null.void
Whether or not this catalog is hidden from selection in the admin.void
The context id, which is a separate identifier from the database primary key.void
The level for a catalog in the tree going from least (root nodes) to highest (leaf nodes).void
Allows for segmenting catalogs via their locale, and encodes the assumption of the defaulted region for all items contained within it.void
The name for the catalogvoid
setOwningApplication
(String owningApplication) Soft reference to the application contextId that owns this catalog.void
setParents
(List<CatalogRef> parents) The parent nodes for this catalog, including additional mutability information.void
setVendorRef
(String vendorRef) Soft reference to the vendor associated with this catalog.toString()
-
Constructor Details
-
Catalog
public Catalog()
-
-
Method Details
-
getId
The context id, which is a separate identifier from the database primary key. This may be auto generated, or may be explicitly provided upon entity creation.- Returns:
- Separate identifier from the database primary key
-
getOwningApplication
Soft reference to the application contextId that owns this catalog. This value can be null, in which case, this is a global catalog.- Returns:
- Soft reference to the application contextId that owns this catalog
-
getName
The name for the catalog- Returns:
- The name for the catalog
-
getHidden
Whether or not this catalog is hidden from selection in the admin. This also indicates the catalog is not available for mutation via theowningApplication
. Note that mutability of a catalog assigned to an application (seeApplicationCatalogRef.getId()
) is controlled via the properties onApplicationCatalogRef
.- Returns:
- Whether or not this catalog is hidden from selection in the admin
-
getParents
The parent nodes for this catalog, including additional mutability information.- Returns:
- The parent nodes for this catalog
-
getLocale
Allows for segmenting catalogs via their locale, and encodes the assumption of the defaulted region for all items contained within it.- Returns:
- the
Locale
for all of the items contained within
-
getDefaultCurrency
DefaultCurrency
associated with this catalog, or null.- Returns:
- the default currency associated with this catalog or null
-
getVendorRef
Soft reference to the vendor associated with this catalog. This value can be null, in which case, no vendor is associated.- Returns:
- Soft reference to the vendor associated with this catalog.
-
getLevel
The level for a catalog in the tree going from least (root nodes) to highest (leaf nodes). This is primarily used for sorting in a given inheritance line.This value is solely maintained on the server and is not intended to be communicated or updated via the API.
- Returns:
- The level for a catalog in the tree
-
getContextState
A subset ofTracking
information to expose the context state for this object.- Specified by:
getContextState
in interfaceContextStateAware
- Returns:
- a subset of
Tracking
information to expose the context state for this object
-
setId
The context id, which is a separate identifier from the database primary key. This may be auto generated, or may be explicitly provided upon entity creation.- Parameters:
id
- Separate identifier from the database primary key
-
setOwningApplication
Soft reference to the application contextId that owns this catalog. This value can be null, in which case, this is a global catalog.- Parameters:
owningApplication
- Soft reference to the application contextId that owns this catalog
-
setName
The name for the catalog- Parameters:
name
- The name for the catalog
-
setHidden
Whether or not this catalog is hidden from selection in the admin. This also indicates the catalog is not available for mutation via theowningApplication
. Note that mutability of a catalog assigned to an application (seeApplicationCatalogRef.getId()
) is controlled via the properties onApplicationCatalogRef
.- Parameters:
hidden
- Whether or not this catalog is hidden from selection in the admin
-
setParents
The parent nodes for this catalog, including additional mutability information.- Parameters:
parents
- The parent nodes for this catalog
-
setLocale
Allows for segmenting catalogs via their locale, and encodes the assumption of the defaulted region for all items contained within it.- Parameters:
locale
- theLocale
that all items within this catalog applies to
-
setDefaultCurrency
DefaultCurrency
associated with this catalog, or null.- Parameters:
the
- default currency associated with this catalog
-
setVendorRef
Soft reference to the vendor associated with this catalog. This value can be null, in which case, no vendor is associated.- Parameters:
vendorRef
- Soft reference to the vendor associated with this catalog.
-
setLevel
The level for a catalog in the tree going from least (root nodes) to highest (leaf nodes). This is primarily used for sorting in a given inheritance line.This value is solely maintained on the server and is not intended to be communicated or updated via the API.
- Parameters:
level
- The level for a catalog in the tree
-
setContextState
A subset ofTracking
information to expose the context state for this object.- Specified by:
setContextState
in interfaceContextStateAware
- Parameters:
contextState
- a subset ofTracking
information to expose the context state for this object
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-