Salesforce B2C Commerce 24.7 > B2C Commerce API > B2C Commerce Script > dw.catalog
dw.catalog
Class Category
Object
dw.object.PersistentObject
dw.object.ExtensibleObject
dw.catalog.Category
Represents a category in a product catalog.
Constants
DISPLAY_MODE_INDIVIDUAL  :  Number = 0
Constant representing the Variation Group Display Mode individual setting.
DISPLAY_MODE_MERGED  :  Number = 1
Constant representing the Variation Group Display Mode merged setting.
Properties
allRecommendations  :  Collection  (Read Only)
All outgoing recommendations for this category. The recommendations are sorted by their explicitly set order.
categoryAssignments  :  Collection  (Read Only)
A collection of category assignments of the category.
defaultSortingRule  :  SortingRule  (Read Only)
The default sorting rule configured for this category, or null if there is no default rule to be applied for it. This method returns the default rule for the parent category if this category inherits one. The parent category may inherit its default rule from its parent, and so on, up to the root category. This method returns null if no ancestor category for this category has a default rule.
description  :  String  (Read Only)
The description of the catalog category for the current locale.
displayMode  :  Number
The Variation Groups Display Mode of the category or null if no display mode is defined.
displayName  :  String  (Read Only)
The display name of the of the catalog category for the current locale. This value is intended to be used as the external visible name of the catalog category.
ID  :  String  (Read Only)
The id of the category.
image  :  MediaFile  (Read Only)
The image reference of this catalog category.
incomingCategoryLinks  :  Collection  (Read Only)
The collection of CategoryLink objects for which this category is the target. If the source category of a link belongs to a different catalog than the catalog owning this category, it is not returned.
online  :  boolean  (Read Only)
The value indicating whether the catalog category is "currently online". A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.
onlineCategoryAssignments  :  Collection  (Read Only)
A collection of category assignments of the category where the referenced product is currently online. When checking the online status of the product, the online flag and the online from & to dates are taken into account. Online flag, online from & to dates set for the current site takes precedence over the default values.
onlineFlag  :  boolean  (Read Only)
The online status flag of the category.
onlineFrom  :  Date  (Read Only)
The date from which the category is online or valid.
onlineIncomingCategoryLinks  :  Collection  (Read Only)
The collection of CategoryLink objects for which this category is the target. If the source category of a link belongs to a different catalog than the catalog owning this category, it is not returned. Additionally, this method will only return a link if the source category is currently online. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.
onlineOutgoingCategoryLinks  :  Collection  (Read Only)
The collection of CategoryLink objects for which this category is the source. If the target category of a link belongs to a different catalog than the catalog owning this category, it is not returned. Additionally, this method will only return a link if the target category is currently online. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.
onlineProducts  :  Collection  (Read Only)
Returns online products assigned to this category. Offline products are not included in the returned collection. When checking the online status of the product, the online flag and the online from & to dates are taken into account. Online flag, online from & to dates set for the current site takes precedence over the default values.
The order of products in the returned collection corresponds to the defined explicit sorting of products in this category.
onlineSubCategories  :  Collection  (Read Only)
A sorted collection of currently online subcategories of this catalog category.
  • A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.
  • The returned collection is sorted by position. Subcategories marked as "unsorted" always appear after those marked as "sorted" but are otherwise not in any guaranteed order.
  • The returned collection contains direct subcategories only.
onlineTo  :  Date  (Read Only)
The date until which the category is online or valid.
orderableRecommendations  :  Collection  (Read Only)
A list of outgoing recommendations for this category. This method behaves similarly to getRecommendations() but additionally filters out recommendations for which the target product is unorderable according to its product availability model.
outgoingCategoryLinks  :  Collection  (Read Only)
The collection of CategoryLink objects for which this category is the source. If the target category of a link belongs to a different catalog than the catalog owning this category, it is not returned. The collection of links is sorted by the explicitly defined order for this category with unsorted links appearing at the end.
pageDescription  :  String  (Read Only)
The page description of this category for the default locale or null if not defined.
pageKeywords  :  String  (Read Only)
The page keywords of this category for the default locale or null if not defined.
pageTitle  :  String  (Read Only)
The page title of this category for the default locale or null if not defined.
pageURL  :  String  (Read Only)
The page URL property of this category or null if not defined.
parent  :  Category  (Read Only)
The parent of this category.
productAttributeModel  :  ProductAttributeModel  (Read Only)
Returns this category's ProductAttributeModel, which makes access to the category's attribute information convenient. The model is calculated based on the attribute definitions assigned to this category and the global attribute definitions for the object type 'Product'.
products  :  Collection  (Read Only)
All products assigned to this category. The order of products in the returned collection corresponds to the defined explicit sorting of products in this category.
recommendations  :  Collection  (Read Only)
The outgoing recommendations for this category. If this category is not in the site catalog, or there is no site catalog, an empty collection is returned. Only recommendations for which the target product exists and is assigned to the site catalog are returned. The recommendations are sorted by their explicitly set order.
root  :  boolean  (Read Only)
Identifies if the category is the root category of its catalog.
searchPlacement  :  Number
The search placement of the category or null of no search placement is defined.
searchRank  :  Number
The search rank of the category or null of no search rank is defined.
siteMapChangeFrequency  :  String  (Read Only)
The category's sitemap change frequency.
siteMapIncluded  :  Number  (Read Only)
The category's sitemap inclusion.
siteMapPriority  :  Number  (Read Only)
The category's sitemap priority.
subCategories  :  Collection  (Read Only)
A sorted collection of the subcategories of this catalog category, including both online and offline subcategories.
  • The returned collection is sorted by position. Subcategories marked as "unsorted" always appear after those marked as "sorted" but are otherwise not in any guaranteed order.
  • The returned collection contains direct subcategories only.
template  :  String  (Read Only)
The template property value , which is the file name of the template used to display the catalog category.
thumbnail  :  MediaFile  (Read Only)
The thumbnail image reference of this catalog category.
topLevel  :  boolean  (Read Only)
Returns true if the category is a top level category, but not the root category.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getAllRecommendations() : Collection
Returns all outgoing recommendations for this category.
getAllRecommendations(type : Number) : Collection
Returns all outgoing recommendations for this category which are of the specified type.
getCategoryAssignments() : Collection
Returns a collection of category assignments of the category.
getDefaultSortingRule() : SortingRule
Returns the default sorting rule configured for this category, or null if there is no default rule to be applied for it.
getDescription() : String
Returns the description of the catalog category for the current locale.
getDisplayMode() : Number
Returns the Variation Groups Display Mode of the category or null if no display mode is defined.
getDisplayName() : String
Returns the display name of the of the catalog category for the current locale.
getID() : String
Returns the id of the category.
getImage() : MediaFile
Returns the image reference of this catalog category.
getIncomingCategoryLinks() : Collection
Returns the collection of CategoryLink objects for which this category is the target.
getIncomingCategoryLinks(type : Number) : Collection
Returns the collection of CategoryLink objects for which this category is the target and which are of the specified type.
getOnlineCategoryAssignments() : Collection
Returns a collection of category assignments of the category where the referenced product is currently online.
getOnlineFlag() : boolean
Returns the online status flag of the category.
getOnlineFrom() : Date
Returns the date from which the category is online or valid.
getOnlineIncomingCategoryLinks() : Collection
Returns the collection of CategoryLink objects for which this category is the target.
getOnlineOutgoingCategoryLinks() : Collection
Returns the collection of CategoryLink objects for which this category is the source.
getOnlineProducts() : Collection
Returns online products assigned to this category.
getOnlineSubCategories() : Collection
Returns a sorted collection of currently online subcategories of this catalog category.
getOnlineTo() : Date
Returns the date until which the category is online or valid.
getOrderableRecommendations() : Collection
Returns a list of outgoing recommendations for this category.
getOrderableRecommendations(type : Number) : Collection
Returns a list of outgoing recommendations for this category.
getOutgoingCategoryLinks() : Collection
Returns the collection of CategoryLink objects for which this category is the source.
getOutgoingCategoryLinks(type : Number) : Collection
Returns the collection of CategoryLink objects for which this category is the source and which are of the specified type.
getPageDescription() : String
Returns the page description of this category for the default locale or null if not defined.
getPageKeywords() : String
Returns the page keywords of this category for the default locale or null if not defined.
getPageTitle() : String
Returns the page title of this category for the default locale or null if not defined.
getPageURL() : String
Returns the page URL property of this category or null if not defined.
getParent() : Category
Returns the parent of this category.
getProductAttributeModel() : ProductAttributeModel
Returns this category's ProductAttributeModel, which makes access to the category's attribute information convenient.
getProducts() : Collection
Returns all products assigned to this category.
getRecommendations() : Collection
Returns the outgoing recommendations for this category.
getRecommendations(type : Number) : Collection
Returns the outgoing recommendations for this category which are of the specified type.
getSearchPlacement() : Number
Returns the search placement of the category or null of no search placement is defined.
getSearchRank() : Number
Returns the search rank of the category or null of no search rank is defined.
getSiteMapChangeFrequency() : String
Returns the category's sitemap change frequency.
getSiteMapIncluded() : Number
Returns the category's sitemap inclusion.
getSiteMapPriority() : Number
Returns the category's sitemap priority.
getSubCategories() : Collection
Returns a sorted collection of the subcategories of this catalog category, including both online and offline subcategories.
getTemplate() : String
Returns the template property value , which is the file name of the template used to display the catalog category.
getThumbnail() : MediaFile
Returns the thumbnail image reference of this catalog category.
hasOnlineProducts() : boolean
Returns true if this catalog category has any online products assigned.
hasOnlineSubCategories() : boolean
Returns true if this catalog category has any online subcategories.
isDirectSubCategoryOf(parent : Category) : boolean
Returns true if this category is a direct sub-category of the provided category.
isOnline() : boolean
Returns the value indicating whether the catalog category is "currently online".
isRoot() : boolean
Identifies if the category is the root category of its catalog.
isSubCategoryOf(ancestor : Category) : boolean
Returns true if this category is a sub-category of the provided category.
isTopLevel() : boolean
Returns true if the category is a top level category, but not the root category.
setDisplayMode(displayMode : Number) : void
Set the category's Variation Groups Display Mode.
setSearchPlacement(placement : Number) : void
Set the category's search placement.
setSearchRank(rank : Number) : void
Set the category's search rank.
Methods inherited from class ExtensibleObject
describe, getCustom
Methods inherited from class PersistentObject
getCreationDate, getLastModified, getUUID
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Method Detail
getAllRecommendations
getAllRecommendations() : Collection
Returns all outgoing recommendations for this category. The recommendations are sorted by their explicitly set order.
Returns:
the sorted collection of recommendations, never null but possibly empty.
getAllRecommendations
getAllRecommendations(type : Number) : Collection
Returns all outgoing recommendations for this category which are of the specified type. The recommendations are sorted by their explicitly set order.
Parameters:
type - the recommendation type.
Returns:
the sorted collection of recommendations, never null but possibly empty.
getCategoryAssignments
getCategoryAssignments() : Collection
Returns a collection of category assignments of the category.
Returns:
Collection of category assignments of the category.
getDefaultSortingRule
getDefaultSortingRule() : SortingRule
Returns the default sorting rule configured for this category, or null if there is no default rule to be applied for it. This method returns the default rule for the parent category if this category inherits one. The parent category may inherit its default rule from its parent, and so on, up to the root category. This method returns null if no ancestor category for this category has a default rule.
Returns:
the default SortingRule or null.
getDescription
getDescription() : String
Returns the description of the catalog category for the current locale.
Returns:
The value of the property for the current locale, or null if it wasn't found.
getDisplayMode
getDisplayMode() : Number
Returns the Variation Groups Display Mode of the category or null if no display mode is defined.
Returns:
the value of the attribute 'displayMode' which is either DISPLAY_MODE_MERGED or DISPLAY_MODE_INDIVIDUAL or null if category is set to inherit the display mode.
getDisplayName
getDisplayName() : String
Returns the display name of the of the catalog category for the current locale. This value is intended to be used as the external visible name of the catalog category.
Returns:
The value of the property for the current locale, or null if it wasn't found.
getID
getID() : String
Returns the id of the category.
Returns:
the id of the category.
getImage
getImage() : MediaFile
Returns the image reference of this catalog category.
Returns:
the image reference for this category.
getIncomingCategoryLinks
getIncomingCategoryLinks() : Collection
Returns the collection of CategoryLink objects for which this category is the target. If the source category of a link belongs to a different catalog than the catalog owning this category, it is not returned.
Returns:
a collection of CategoryLink objects, possibly empty but not null.
getIncomingCategoryLinks
getIncomingCategoryLinks(type : Number) : Collection
Returns the collection of CategoryLink objects for which this category is the target and which are of the specified type. If the source category of a link belongs to a different catalog than the catalog owning this category, it is not returned.
Parameters:
type - the link type type.
Returns:
a collection of CategoryLink objects, possibly empty but not null.
getOnlineCategoryAssignments
getOnlineCategoryAssignments() : Collection
Returns a collection of category assignments of the category where the referenced product is currently online. When checking the online status of the product, the online flag and the online from & to dates are taken into account. Online flag, online from & to dates set for the current site takes precedence over the default values.
Returns:
Collection of online category assignments of the category.
getOnlineFlag
getOnlineFlag() : boolean
Returns the online status flag of the category.
Returns:
the online status flag of the category.
getOnlineFrom
getOnlineFrom() : Date
Returns the date from which the category is online or valid.
Returns:
the date from which the category is online or valid.
getOnlineIncomingCategoryLinks
getOnlineIncomingCategoryLinks() : Collection
Returns the collection of CategoryLink objects for which this category is the target. If the source category of a link belongs to a different catalog than the catalog owning this category, it is not returned. Additionally, this method will only return a link if the source category is currently online. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.
Returns:
a collection of CategoryLink objects, possibly empty but not null.
getOnlineOutgoingCategoryLinks
getOnlineOutgoingCategoryLinks() : Collection
Returns the collection of CategoryLink objects for which this category is the source. If the target category of a link belongs to a different catalog than the catalog owning this category, it is not returned. Additionally, this method will only return a link if the target category is currently online. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.
Returns:
a collection of CategoryLink objects, possibly empty but not null.
getOnlineProducts
getOnlineProducts() : Collection
Returns online products assigned to this category. Offline products are not included in the returned collection. When checking the online status of the product, the online flag and the online from & to dates are taken into account. Online flag, online from & to dates set for the current site takes precedence over the default values.
The order of products in the returned collection corresponds to the defined explicit sorting of products in this category.
Returns:
a sorted collection of online products of this category.
See Also:
hasOnlineProducts()
getOnlineSubCategories
getOnlineSubCategories() : Collection
Returns a sorted collection of currently online subcategories of this catalog category.
  • A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.
  • The returned collection is sorted by position. Subcategories marked as "unsorted" always appear after those marked as "sorted" but are otherwise not in any guaranteed order.
  • The returned collection contains direct subcategories only.
Returns:
a sorted collection of currently online subcategories.
See Also:
hasOnlineSubCategories()
getOnlineTo
getOnlineTo() : Date
Returns the date until which the category is online or valid.
Returns:
the date until which the category is online or valid.
getOrderableRecommendations
getOrderableRecommendations() : Collection
Returns a list of outgoing recommendations for this category. This method behaves similarly to getRecommendations() but additionally filters out recommendations for which the target product is unorderable according to its product availability model.
Returns:
the sorted collection of recommendations, never null but possibly empty.
See Also:
ProductAvailabilityModel.isOrderable()
getOrderableRecommendations
getOrderableRecommendations(type : Number) : Collection
Returns a list of outgoing recommendations for this category. This method behaves similarly to getRecommendations(Number) but additionally filters out recommendations for which the target product is unorderable according to its product availability model.
Parameters:
type - the recommendation type.
Returns:
the sorted collection of recommendations, never null but possibly empty.
See Also:
ProductAvailabilityModel.isOrderable()
getOutgoingCategoryLinks
getOutgoingCategoryLinks() : Collection
Returns the collection of CategoryLink objects for which this category is the source. If the target category of a link belongs to a different catalog than the catalog owning this category, it is not returned. The collection of links is sorted by the explicitly defined order for this category with unsorted links appearing at the end.
Returns:
a collection of CategoryLink objects, possibly empty but not null.
getOutgoingCategoryLinks
getOutgoingCategoryLinks(type : Number) : Collection
Returns the collection of CategoryLink objects for which this category is the source and which are of the specified type. If the target category of a link belongs to a different catalog than the catalog owning this category, it is not returned. The collection of links is sorted by the explicitly defined order for this category with unsorted links appearing at the end.
Parameters:
type - the link type type.
Returns:
a collection of CategoryLink objects, possibly empty but not null.
getPageDescription
getPageDescription() : String
Returns the page description of this category for the default locale or null if not defined.
Returns:
the value of the attribute 'pageDescription'.
getPageKeywords
getPageKeywords() : String
Returns the page keywords of this category for the default locale or null if not defined.
Returns:
the value of the attribute 'pageKeywords'.
getPageTitle
getPageTitle() : String
Returns the page title of this category for the default locale or null if not defined.
Returns:
the value of the attribute 'pageTitle'.
getPageURL
getPageURL() : String
Returns the page URL property of this category or null if not defined.
Returns:
the value of the attribute 'pageURL'.
getParent
getParent() : Category
Returns the parent of this category.
Returns:
a CatalogCategory instance representing the parent of this CatalogCategory or null.
getProductAttributeModel
getProductAttributeModel() : ProductAttributeModel
Returns this category's ProductAttributeModel, which makes access to the category's attribute information convenient. The model is calculated based on the attribute definitions assigned to this category and the global attribute definitions for the object type 'Product'.
Returns:
the ProductAttributeModel for this category.
getProducts
getProducts() : Collection
Returns all products assigned to this category. The order of products in the returned collection corresponds to the defined explicit sorting of products in this category.
Returns:
a sorted collection of all products of this category.
See Also:
getOnlineProducts()
getRecommendations
getRecommendations() : Collection
Returns the outgoing recommendations for this category. If this category is not in the site catalog, or there is no site catalog, an empty collection is returned. Only recommendations for which the target product exists and is assigned to the site catalog are returned. The recommendations are sorted by their explicitly set order.
Returns:
the sorted collection of recommendations, never null but possibly empty.
getRecommendations
getRecommendations(type : Number) : Collection
Returns the outgoing recommendations for this category which are of the specified type. Behaves the same as getRecommendations() but additionally filters by recommendation type.
Parameters:
type - the recommendation type.
Returns:
the sorted collection of recommendations, never null but possibly empty.
getSearchPlacement
getSearchPlacement() : Number
Returns the search placement of the category or null of no search placement is defined.
Returns:
the value of the attribute 'searchPlacement'.
getSearchRank
getSearchRank() : Number
Returns the search rank of the category or null of no search rank is defined.
Returns:
the value of the attribute 'searchRank'.
getSiteMapChangeFrequency
getSiteMapChangeFrequency() : String
Returns the category's sitemap change frequency.
Returns:
the value of the attribute 'siteMapChangeFrequency'.
getSiteMapIncluded
getSiteMapIncluded() : Number
Returns the category's sitemap inclusion.
Returns:
the value of the attribute 'siteMapIncluded'.
getSiteMapPriority
getSiteMapPriority() : Number
Returns the category's sitemap priority.
Returns:
the value of the attribute 'siteMapPriority'.
getSubCategories
getSubCategories() : Collection
Returns a sorted collection of the subcategories of this catalog category, including both online and offline subcategories.
  • The returned collection is sorted by position. Subcategories marked as "unsorted" always appear after those marked as "sorted" but are otherwise not in any guaranteed order.
  • The returned collection contains direct subcategories only.
Returns:
a sorted collection of the subcategories.
See Also:
getOnlineSubCategories()
getTemplate
getTemplate() : String
Returns the template property value , which is the file name of the template used to display the catalog category.
Returns:
the value of the property 'template'.
getThumbnail
getThumbnail() : MediaFile
Returns the thumbnail image reference of this catalog category.
Returns:
the thumbnail image reference for this category.
hasOnlineProducts
hasOnlineProducts() : boolean
Returns true if this catalog category has any online products assigned. When checking the online status of the product, the online flag and the online from & to dates are taken into account. Online flag, online from & to dates set for the current site takes precedence over the default values.
Returns:
true, if this category has at least one online product assigned, false otherwise.
See Also:
getOnlineProducts()
hasOnlineSubCategories
hasOnlineSubCategories() : boolean
Returns true if this catalog category has any online subcategories.
  • A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.
  • Only direct subcategories are considered.
Returns:
true, if this category has at least one online subcategory, false otherwise.
See Also:
getOnlineSubCategories()
isDirectSubCategoryOf
isDirectSubCategoryOf(parent : Category) : boolean
Returns true if this category is a direct sub-category of the provided category.
Parameters:
parent - The parent category, must not be null.
Returns:
True if this category is a direct sub-category of parent, false otherwise.
isOnline
isOnline() : boolean
Returns the value indicating whether the catalog category is "currently online". A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.
Returns:
true if the category is currently online, false otherwise.
isRoot
isRoot() : boolean
Identifies if the category is the root category of its catalog.
Returns:
'true' if the category is the root category of its catalog, 'false' otherwise.
isSubCategoryOf
isSubCategoryOf(ancestor : Category) : boolean
Returns true if this category is a sub-category of the provided category. This can be either a direct or an indirect sub-category.
Parameters:
ancestor - The ancestor category, must not be null.
Returns:
true if this category is a sub-category of ancestor, false otherwise.
isTopLevel
isTopLevel() : boolean
Returns true if the category is a top level category, but not the root category.
Returns:
True if the category is a direct sub-category of the root category, false otherwise.
setDisplayMode
setDisplayMode(displayMode : Number) : void
Set the category's Variation Groups Display Mode.
Parameters:
displayMode - The category's variation groups display mode which is either DISPLAY_MODE_MERGED or DISPLAY_MODE_INDIVIDUAL or null if category is set to inherit the display mode.
setSearchPlacement
setSearchPlacement(placement : Number) : void
Set the category's search placement.
Parameters:
placement - The category's search placement.
setSearchRank
setSearchRank(rank : Number) : void
Set the category's search rank.
Parameters:
rank - The category's search rank.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.