ATG Commerce Programming Guide

ancestorCategories

CMS

All the categories that can be used to navigate to (through category.childCategories) to this category, regardless of catalog. (category.childCategories is a combination of fixedChildCategories and subCatalogsChildCategories)

ancestorCategoryIds

Implicitly set by CMS

RepositoryIDs of the ancestor categories. Read-only. Uses same database table as ancestorCategories

auxiliaryMedia

ACC

Additional media to be displayed with this category.

catalog

Derived in development mode

Set by CMS in production mode.

This is the catalog that owns this category. In development mode this is derived (non-queryable) by walking up the parentCategory until a catalog is reached. In production, this value is set by the CatalogMaintenanceService. This is used to determine the catalog whose Access Control List should be used for admin permissions.

catalogs

Derived in development mode

Set by CMS in production mode.

All the catalogs that include some path to this category. In development this is derived (Alias of catalog.ancestorCatalogsAndSelf but is not queryable. In production this is set by the CatalogMaintenanceService. This is used to determine whether an end user has permission to view this catalog.

categoryInfos

ACC (optional)

Map from catalogId to a categoryInfo. While a category can only be directly contained by one catalog, that catalog can be contained within another catalog, in which case an entry is placed in this map.

childCategories

derived

List of all categories that are children of this category; a merge of fixedChildCategories and dynamicChildCategories. Read-only.

childCategoryGroup

ACC

Name of the content group that contains the list of dynamicChildCategories.

childProductGroup

ACC

Name of the content group that contains the list of dynamicChildProducts.

childProducts

ACC

List of all products that are children of this category; a merge of fixedChildProducts and dynamicChildProducts. Read-only.

creationDate

Implicitly set by GSA

Date this category was created. Read-only.

description

ACC

Short descriptive text for display with this category.

displayName

ACC

Name used for the category on the site. Required.

dynamicChildCategories

derived

List of the categories in the content group specified by the childCategoryGroup property. Read-only.

dynamicChildProducts

derived

List of the products in the content group specified by the childProductGroup property. Read-only.

dynamicRelatedCategories

derived

List of the categories in the content group specified by the relatedCategoryGroup property. Read-only.

endDate

ACC

Date this category will no longer be available, if a collection filter is implemented to use this property.

fixedChildCategories

ACC

List of child categories of this category. Used by catalog admin to explicitly set the descendant categories of a category.

fixedChildProducts

ACC

List of child products of this category. Used by catalog admin to explicitly set the descendant products of a category.

fixedRelatedCategories

ACC

Static list of categories related to this category.

id

ACC

RepositoryID for this category. If this property is not set through the ACC during creation, it implicitly set by GSA

keywords

ACC

Set of words that can be used in searching for this category.

largeImage

ACC

Large image associated with the category.

longDescription

ACC

Detailed descriptive text for display with this category.

parentCatalog

CCS

The parent catalog of this category. This will only hold a value if the catalog is a rootCategory of the given catalog. This is used in the ParentCatalog derivation.

parentCategory

CCS

The parent category of this category. It is possible there is more than one choice here. The CatalogCompletionService will arbitrarily choose one (if the value is null). Users can explicitly change this if they wish. The purpose is twofold: 1) used in breadcrumbs 2) used in “Catalog” derivation to walk up the category tree to find the containing catalog.

relatedCategories

derived

List of all categories that are children of this category; this represents a merge of fixedRelatedCategories,dynamicRelatedCategories, and the categoryInfo property catalogsRelatedCategories. Read-only.

relatedCategoryGroup

ACC

Name of the content group that contains the list of categories that dynamicRelatedCategories is set to.

smallImage

ACC

Small image associated with the category.

startDate

ACC

Date this category becomes available, if a collection filter is implemented to use this property.

subCatalogs

ACC

List of catalogs whose root categories will be considered child categories of this category. Used by catalog admin to explicitly set direct descendant catalogs of a category.

subCatalogsChildCategories

derived

The CollectiveUnion of the “allRootCategories” of each catalog in “subCatalogs”. Used to help compile the “childCategories” property - the complete list of all descendant categories of a category.

template

ACC

JSP used to display this category.

thumbnailImage

ACC

Thumbnail image associated with this category.

type

Not used out-of-the-box

Provided for subclassing purposes; use to indicate if an item belongs to the superclass or a subclass. Read-only.

version

Implicitly set by GSA

Integer that is incremented automatically each time the category is updated; used to prevent version conflict.