Class CatalogNode
Contains information about a category within catalog.
Inheritance
Inherited Members
Namespace: Mediachase.Commerce.Catalog.Objects
Assembly: Mediachase.Commerce.dll
Version: 10.8.0Syntax
public class CatalogNodeConstructors
CatalogNode()
Initializes a new instance of the CatalogNode class.
Declaration
public CatalogNode()Remarks
The parameterless constructor is intended to be used only when simulating node data for display or default case purposes, and is not intended to be used when loading persisted data from the database. Please use the parameterized constructor when loading persisted data.
CatalogNode(CatalogNodeDto.CatalogNodeRow)
Initializes a new instance of the CatalogNode class. Backwards compatible with prior releases.
Declaration
public CatalogNode(CatalogNodeDto.CatalogNodeRow input)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogNodeDto.CatalogNodeRow | input | The catalog node row being processed. |
Remarks
This constructor will be marked obsolete in future releases. Please use the CatalogNode(CatalogNodeDto.CatalogNodeRow, CatalogNodeResponseGroup.ResponseGroup) constructor instead. This Node record will not be marked with any CatalogNodeResponseGroup flags by default.
CatalogNode(CatalogNodeDto.CatalogNodeRow, CatalogNodeResponseGroup.ResponseGroup)
Initializes a new instance of the CatalogNode class.
Declaration
public CatalogNode(CatalogNodeDto.CatalogNodeRow input, CatalogNodeResponseGroup.ResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogNodeDto.CatalogNodeRow | input | The catalog node row being processed. |
| CatalogNodeResponseGroup.ResponseGroup | responseGroup | The response group used to determine the scope of the data being loaded from persistent sources. |
Properties
Ancestors
Gets or sets the ancestors.
Declaration
public CatalogNodes Ancestors { get; set; }Property Value
| Type | Description |
|---|---|
| CatalogNodes | The ancestors. |
Assets
Gets or sets the assets.
Declaration
public ItemAsset[] Assets { get; set; }Property Value
| Type | Description |
|---|---|
| ItemAsset[] | The assets. |
CatalogId
Gets or sets the Catalog ID, which corresponds to the CatalogId field in the database.
Declaration
public int CatalogId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The ID. |
CatalogNodeId
Gets or sets the Catalog Node ID, which corresponds to the CatalogNodeId field in the database.
Declaration
public int CatalogNodeId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The ID. |
Children
Gets or sets the children.
Declaration
public CatalogNodes Children { get; set; }Property Value
| Type | Description |
|---|---|
| CatalogNodes | The children. |
DisplayTemplate
Gets or sets the display template.
Declaration
public string DisplayTemplate { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The display template. |
EndDate
Gets or sets the end date.
Declaration
public DateTime EndDate { get; set; }Property Value
| Type | Description |
|---|---|
| System.DateTime | The end date. |
ID
Gets or sets the Catalog Node ID, which corresponds to the Code field in the database.
Declaration
public string ID { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The ID. |
IsActive
Gets or sets a value indicating whether this instance is active.
Declaration
public bool IsActive { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
ItemAttributes
Gets or sets the item attributes.
Declaration
public ItemAttributes ItemAttributes { get; set; }Property Value
| Type | Description |
|---|---|
| ItemAttributes | The item attributes. |
Name
Gets or sets the name.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The name. |
ParentNode
Gets or sets the parent node.
Declaration
public CatalogNode ParentNode { get; set; }Property Value
| Type | Description |
|---|---|
| CatalogNode | The parent node. |
ParentNodeId
Gets or sets the Parent Node ID, which corresponds to the ParentNodeId field in the database.
Declaration
public int ParentNodeId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The ID. |
ResponseGroup
Gets the ResponseGroup, which indicates how much related data has been loaded into the CatalogNode.
Declaration
public CatalogNodeResponseGroup.ResponseGroup ResponseGroup { get; set; }Property Value
| Type | Description |
|---|---|
| CatalogNodeResponseGroup.ResponseGroup |
Remarks
This flag should be used with care. It is intended as a contract that specifies what related data the CatalogNode
has loaded from the database (e.g. Children, Assets) so that the object can be reused in different contexts.
Generally if the node was not loaded from the database, the CatalogNode object should be used for a specific
purpose with a short lifetime where all actions on it are deliberate, and this flag should be null.
Data may be set freely independently of this flag setting, and the flag will not change to reflect updates to the
fields. This is intended to allow the developer the ability to distinguish between persisted and non-persisted data,
so long as the flag is set properly.
SeoInfo
Gets or sets the seo info.
Declaration
public Seo[] SeoInfo { get; set; }Property Value
| Type | Description |
|---|---|
| Seo[] | The seo info. |
StartDate
Gets or sets the start date.
Declaration
public DateTime StartDate { get; set; }Property Value
| Type | Description |
|---|---|
| System.DateTime | The start date. |
