Interface ICatalogSystem
Provides the methods necessary for the ICatalogSystem.
Namespace: Mediachase.Commerce.Catalog
Assembly: Mediachase.Commerce.dll
Version: 13.30.0Syntax
public interface ICatalogSystemMethods
ContinueFindItemsForIndexing(Guid, Int32, Int32)
Gets a section of results from StartFindItemsForIndexing.
Declaration
CatalogEntryDto ContinueFindItemsForIndexing(Guid searchSetId, int firstResultIndex, int maxResultCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | searchSetId | The identifier for the search set. The search set must be initialized with with StartFindItemsForIndexing. |
| System.Int32 | firstResultIndex | The lowest result index to return. Result indexes are 1-based. |
| System.Int32 | maxResultCount | The maximum number of results to return. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto | A CatalogEntryDto containing the results. |
Remarks
Once a CatalogEntry is recieved from this call, it will not be returned again. Repeated calls with the same firstResultIndex and maxResultCount will result in empty data sets for all but the first such call.
DeleteCatalog(Int32)
Deletes the catalog.
Declaration
void DeleteCatalog(int catalogId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
DeleteCatalogEntries(IEnumerable<Int32>)
Deletes multiple catalog entries.
Declaration
void DeleteCatalogEntries(IEnumerable<int> catalogEntryIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.Int32> | catalogEntryIds | The IDs of the entries to delete. |
DeleteCatalogEntry(Int32, Boolean)
Deletes the entry.
Declaration
void DeleteCatalogEntry(int entryId, bool recursive)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | entryId | The entry id. |
| System.Boolean | recursive | if set to |
DeleteCatalogNode(Int32)
Deletes the catalog node by node id.
Declaration
void DeleteCatalogNode(int catalogNodeId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogNodeId | The catalog node id. |
DeleteCatalogNode(Int32, Int32)
Deletes the catalog node.
Declaration
void DeleteCatalogNode(int catalogNodeId, int catalogId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogNodeId | The catalog node id. |
| System.Int32 | catalogId | The catalog id. |
DeleteCatalogNodeAndEntries(Int32)
Deletes the catalog node and all child nodes (not links) by node id, and deletes all entries that will no longer belong to any nodes. Any or node entry that is under the node and is not deleted, including via links, will have their modified date updated to the current date and time.
Declaration
void DeleteCatalogNodeAndEntries(int catalogNodeId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogNodeId | The ID of the catalog node to delete. |
DeleteCatalogNodeAndEntries(Int32, Int32)
Deletes the catalog node and all child nodes (not links), and deletes all entries that will no longer belong to any nodes. Any or node entry that is under the node and is not deleted, including via links, will have their modified date updated to the current date and time.
Declaration
void DeleteCatalogNodeAndEntries(int catalogNodeId, int catalogId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogNodeId | The ID of the catalog node to delete. |
| System.Int32 | catalogId | The ID of the catalog to work within. |
DeleteCatalogNodesAndEntries(IEnumerable<Int32>)
Deletes the catalog nodes and all child nodes (not links), and deletes all entries that will no longer belong to any nodes. Any or node entry that is under the node and is not deleted, including via links, will have their modified date updated to the current date and time.
Declaration
void DeleteCatalogNodesAndEntries(IEnumerable<int> catalogNodeIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<System.Int32> | catalogNodeIds | The IDs of the catalog nodes to delete. |
FindCatalogItemsTable(ItemSearchParameters)
Finds the catalog items table.
Declaration
DataTable FindCatalogItemsTable(ItemSearchParameters parameters)Parameters
| Type | Name | Description |
|---|---|---|
| ItemSearchParameters | parameters | The parameters. |
Returns
| Type | Description |
|---|---|
| System.Data.DataTable |
FindCatalogItemsTable(ItemSearchParameters, CatalogNodeResponseGroup)
Finds the catalog items table.
Declaration
DataTable FindCatalogItemsTable(ItemSearchParameters parameters, CatalogNodeResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| ItemSearchParameters | parameters | The parameters. |
| CatalogNodeResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| System.Data.DataTable |
FindItemsDto(CatalogSearchParameters, CatalogSearchOptions, ref Int32)
Finds the items dto.
Declaration
CatalogEntryDto FindItemsDto(CatalogSearchParameters parameters, CatalogSearchOptions options, ref int recordsCount)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogSearchParameters | parameters | The parameters. |
| CatalogSearchOptions | options | The search options. |
| System.Int32 | recordsCount | Returns the records count. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto | The CatalogEntryDto |
FindItemsDto(CatalogSearchParameters, CatalogSearchOptions, ref Int32, CatalogEntryResponseGroup)
Finds the items dto.
Declaration
CatalogEntryDto FindItemsDto(CatalogSearchParameters parameters, CatalogSearchOptions options, ref int recordsCount, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogSearchParameters | parameters | The parameters. |
| CatalogSearchOptions | options | The options. |
| System.Int32 | recordsCount | The records count. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
FindNodesDto(CatalogSearchParameters, CatalogSearchOptions, ref Int32)
Finds the nodes dto.
Declaration
CatalogNodeDto FindNodesDto(CatalogSearchParameters parameters, CatalogSearchOptions options, ref int recordsCount)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogSearchParameters | parameters | The parameters. |
| CatalogSearchOptions | options | The options. |
| System.Int32 | recordsCount | The records count. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
FindNodesDto(CatalogSearchParameters, CatalogSearchOptions, ref Int32, CatalogNodeResponseGroup)
Finds the nodes dto.
Declaration
CatalogNodeDto FindNodesDto(CatalogSearchParameters parameters, CatalogSearchOptions options, ref int recordsCount, CatalogNodeResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogSearchParameters | parameters | The parameters. |
| CatalogSearchOptions | options | The options. |
| System.Int32 | recordsCount | The records count. |
| CatalogNodeResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetAssociatedCatalogEntriesDto(Int32, String)
Gets the associated catalog entries dto.
Declaration
CatalogEntryDto GetAssociatedCatalogEntriesDto(int parentEntryId, string associationName)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | parentEntryId | The parent entry id. |
| System.String | associationName | Name of the association. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetAssociatedCatalogEntriesDto(Int32, String, CatalogEntryResponseGroup)
Gets the associated catalog entries dto.
Declaration
CatalogEntryDto GetAssociatedCatalogEntriesDto(int parentEntryId, string associationName, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | parentEntryId | The parent entry id. |
| System.String | associationName | Name of the association. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetAssociatedCatalogEntriesDto(String, String)
Gets the associated catalog entries dto.
Declaration
CatalogEntryDto GetAssociatedCatalogEntriesDto(string parentEntryCode, string associationName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | parentEntryCode | The parent entry code. |
| System.String | associationName | Name of the association. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetAssociatedCatalogEntriesDto(String, String, CatalogEntryResponseGroup)
Gets the associated catalog entries dto.
Declaration
CatalogEntryDto GetAssociatedCatalogEntriesDto(string parentEntryCode, string associationName, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | parentEntryCode | The parent entry code. |
| System.String | associationName | Name of the association. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogAssociationDto(Int32)
Gets the catalog association dto.
Declaration
CatalogAssociationDto GetCatalogAssociationDto(int catalogAssociationId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogAssociationId | The catalog association id. |
Returns
| Type | Description |
|---|---|
| CatalogAssociationDto |
GetCatalogAssociationDto(String)
Gets the catalog association dto.
Declaration
CatalogAssociationDto GetCatalogAssociationDto(string catalogAssociationName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogAssociationName | Name of the catalog association. |
Returns
| Type | Description |
|---|---|
| CatalogAssociationDto |
GetCatalogAssociationDtoByEntryCode(Int32, String)
Gets the catalog association dto by entry code.
Declaration
CatalogAssociationDto GetCatalogAssociationDtoByEntryCode(int catalogId, string catalogEntryCode)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
| System.String | catalogEntryCode | The catalog entry code. |
Returns
| Type | Description |
|---|---|
| CatalogAssociationDto |
GetCatalogAssociationDtoByEntryId(Int32)
Gets the catalog association dto by entry id.
Declaration
CatalogAssociationDto GetCatalogAssociationDtoByEntryId(int catalogEntryId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogEntryId | The catalog entry id. |
Returns
| Type | Description |
|---|---|
| CatalogAssociationDto |
GetCatalogDto()
Gets the catalog dto.
Declaration
CatalogDto GetCatalogDto()Returns
| Type | Description |
|---|---|
| CatalogDto |
GetCatalogDto(Guid)
Gets the catalog dto.
Declaration
[Obsolete("Site functionality no longer supported. Use GetCatalogDto() instead. Will remain at least until March 2019.")]
CatalogDto GetCatalogDto(Guid siteId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | siteId | The site id. |
Returns
| Type | Description |
|---|---|
| CatalogDto |
GetCatalogDto(Guid, CatalogResponseGroup)
Gets the catalog dto.
Declaration
[Obsolete("Site functionality no longer supported. Use GetCatalogDto() instead. Will remain at least until March 2019.")]
CatalogDto GetCatalogDto(Guid siteId, CatalogResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | siteId | The site id. |
| CatalogResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogDto |
GetCatalogDto(Int32)
Gets the catalog dto.
Declaration
CatalogDto GetCatalogDto(int catalogId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
Returns
| Type | Description |
|---|---|
| CatalogDto |
GetCatalogDto(Int32, CatalogResponseGroup)
Gets the catalog dto.
Declaration
CatalogDto GetCatalogDto(int catalogId, CatalogResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
| CatalogResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogDto |
GetCatalogEntriesByNodeDto(String, String)
Gets the catalog entries by node dto.
Declaration
CatalogEntryDto GetCatalogEntriesByNodeDto(string catalogName, string parentNodeCode)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogName | Name of the catalog. |
| System.String | parentNodeCode | The parent node code. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesByNodeDto(String, String, CatalogEntryResponseGroup)
Gets the catalog entries by node dto.
Declaration
CatalogEntryDto GetCatalogEntriesByNodeDto(string catalogName, string parentNodeCode, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogName | Name of the catalog. |
| System.String | parentNodeCode | The parent node code. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(Int32)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(int catalogId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(Int32, CatalogEntryResponseGroup)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(int catalogId, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(Int32, Int32)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(int catalogId, int parentNodeId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
| System.Int32 | parentNodeId | The parent node id. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(Int32, Int32, CatalogEntryResponseGroup)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(int catalogId, int parentNodeId, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
| System.Int32 | parentNodeId | The parent node id. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(Int32, String, String)
Gets the catalog entries dto.
Declaration
[Obsolete("This method is no longer used. Use content API instead. Will remain at least until February 2020.")]
CatalogEntryDto GetCatalogEntriesDto(int parentEntryId, string entryType, string relationType)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | parentEntryId | The parent entry id. |
| System.String | entryType | Type of the entry. |
| System.String | relationType | Type of the relation. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(Int32, String, String, CatalogEntryResponseGroup)
Gets the catalog entries dto.
Declaration
[Obsolete("This method is no longer used. Use content API instead. Will remain at least until February 2020.")]
CatalogEntryDto GetCatalogEntriesDto(int parentEntryId, string entryType, string relationType, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | parentEntryId | The parent entry id. |
| System.String | entryType | Type of the entry. |
| System.String | relationType | Type of the relation. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(Int32[])
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(int[] catalogEntries)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32[] | catalogEntries | The catalog entries. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(Int32[], CatalogEntryResponseGroup)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(int[] catalogEntries, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32[] | catalogEntries | The catalog entries. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(Int32[], Boolean, TimeSpan)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(int[] catalogEntries, bool cacheResults, TimeSpan cacheTimeout)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32[] | catalogEntries | The catalog entries. |
| System.Boolean | cacheResults | if set to |
| System.TimeSpan | cacheTimeout | The cache timeout. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(Int32[], Boolean, TimeSpan, CatalogEntryResponseGroup)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(int[] catalogEntries, bool cacheResults, TimeSpan cacheTimeout, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32[] | catalogEntries | The catalog entries. |
| System.Boolean | cacheResults | If set to |
| System.TimeSpan | cacheTimeout | The cache timeout. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(String)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(string catalogName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogName | Name of the catalog. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(String, CatalogEntryResponseGroup)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(string catalogName, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogName | Name of the catalog. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(String, Int32)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(string catalogName, int parentNodeId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogName | Name of the catalog. |
| System.Int32 | parentNodeId | The parent node id. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(String, Int32, CatalogEntryResponseGroup)
Gets the catalog entries dto.
Declaration
CatalogEntryDto GetCatalogEntriesDto(string catalogName, int parentNodeId, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogName | Name of the catalog. |
| System.Int32 | parentNodeId | The parent node id. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(String, String)
Gets the catalog entries dto.
Declaration
[Obsolete("This method is no longer used. Use content API instead. Will remain at least until February 2020.")]
CatalogEntryDto GetCatalogEntriesDto(string name, string entryType)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name. |
| System.String | entryType | Type of the entry. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntriesDto(String, String, CatalogEntryResponseGroup)
Gets the catalog entries dto.
Declaration
[Obsolete("This method is no longer used. Use content API instead. Will remain at least until February 2020.")]
CatalogEntryDto GetCatalogEntriesDto(string name, string entryType, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name. |
| System.String | entryType | Type of the entry. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntryByUriDto(String, String)
Gets the catalog entry by URI dto.
Declaration
CatalogEntryDto GetCatalogEntryByUriDto(string uri, string languageCode)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | uri | The URI. |
| System.String | languageCode | The language code. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntryByUriDto(String, String, CatalogEntryResponseGroup)
Gets the catalog entry by URI dto.
Declaration
CatalogEntryDto GetCatalogEntryByUriDto(string uri, string languageCode, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | uri | The URI. |
| System.String | languageCode | The language code. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntryDto(Int32)
Gets the catalog entry dto.
Declaration
CatalogEntryDto GetCatalogEntryDto(int catalogEntryId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogEntryId | The catalog entry id. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntryDto(Int32, CatalogEntryResponseGroup)
Gets the catalog entry dto.
Declaration
CatalogEntryDto GetCatalogEntryDto(int catalogEntryId, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogEntryId | The catalog entry id. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntryDto(String)
Gets the catalog entry dto.
Declaration
CatalogEntryDto GetCatalogEntryDto(string catalogEntryCode)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogEntryCode | The catalog entry code. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogEntryDto(String, CatalogEntryResponseGroup)
Gets the catalog entry dto.
Declaration
CatalogEntryDto GetCatalogEntryDto(string catalogEntryCode, CatalogEntryResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogEntryCode | The catalog entry code. |
| CatalogEntryResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
GetCatalogNodeDto(Int32)
Gets the catalog node dto.
Declaration
CatalogNodeDto GetCatalogNodeDto(int catalogNodeId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogNodeId | The catalog node id. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodeDto(Int32, CatalogNodeResponseGroup)
Gets the catalog node dto.
Declaration
CatalogNodeDto GetCatalogNodeDto(int catalogNodeId, CatalogNodeResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogNodeId | The catalog node id. |
| CatalogNodeResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodeDto(String)
Gets the catalog node dto.
Declaration
CatalogNodeDto GetCatalogNodeDto(string code)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | code | The code. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodeDto(String, CatalogNodeResponseGroup)
Gets the catalog node dto.
Declaration
CatalogNodeDto GetCatalogNodeDto(string code, CatalogNodeResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | code | The code. |
| CatalogNodeResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodeDto(String, String)
Gets the catalog node dto.
Declaration
CatalogNodeDto GetCatalogNodeDto(string uri, string languageCode)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | uri | The URI. |
| System.String | languageCode | The language code. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodeDto(String, String, CatalogNodeResponseGroup)
Gets the catalog node dto.
Declaration
CatalogNodeDto GetCatalogNodeDto(string uri, string languageCode, CatalogNodeResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | uri | The URI. |
| System.String | languageCode | The language code. |
| CatalogNodeResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodesDto(Int32)
Gets the catalog nodes dto.
Declaration
CatalogNodeDto GetCatalogNodesDto(int catalogId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodesDto(Int32, CatalogNodeResponseGroup)
Gets the catalog nodes dto.
Declaration
CatalogNodeDto GetCatalogNodesDto(int catalogId, CatalogNodeResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
| CatalogNodeResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodesDto(Int32, Int32)
Gets the catalog nodes dto.
Declaration
CatalogNodeDto GetCatalogNodesDto(int catalogId, int parentNodeId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
| System.Int32 | parentNodeId | The parent node id. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodesDto(String)
Gets the catalog nodes dto.
Declaration
CatalogNodeDto GetCatalogNodesDto(string catalogName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogName | Name of the catalog. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodesDto(String, CatalogNodeResponseGroup)
Gets the catalog nodes dto.
Declaration
CatalogNodeDto GetCatalogNodesDto(string catalogName, CatalogNodeResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogName | Name of the catalog. |
| CatalogNodeResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodesDto(String, String)
Gets the catalog nodes dto.
Declaration
CatalogNodeDto GetCatalogNodesDto(string catalogName, string parentNodeCode)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogName | Name of the catalog. |
| System.String | parentNodeCode | The parent node code. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogNodesDto(String, String, CatalogNodeResponseGroup)
Gets the catalog nodes dto.
Declaration
CatalogNodeDto GetCatalogNodesDto(string catalogName, string parentNodeCode, CatalogNodeResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | catalogName | Name of the catalog. |
| System.String | parentNodeCode | The parent node code. |
| CatalogNodeResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogNodeDto |
GetCatalogRelationDto(Int32)
Gets the catalog relation dto.
Declaration
CatalogRelationDto GetCatalogRelationDto(int childEntryId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | childEntryId | The child entry id. |
Returns
| Type | Description |
|---|---|
| CatalogRelationDto |
GetCatalogRelationDto(Int32, Int32, Int32, String, CatalogRelationResponseGroup)
Gets the catalog relation dto.
Declaration
CatalogRelationDto GetCatalogRelationDto(int catalogId, int catalogNodeId, int catalogEntryId, string groupName, CatalogRelationResponseGroup responseGroup)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | catalogId | The catalog id. |
| System.Int32 | catalogNodeId | The catalog node id. |
| System.Int32 | catalogEntryId | The catalog entry id. |
| System.String | groupName | Name of the group. |
| CatalogRelationResponseGroup | responseGroup | The response group. |
Returns
| Type | Description |
|---|---|
| CatalogRelationDto |
GetCatalogRelationDto(String)
Gets the catalog relation dto.
Declaration
CatalogRelationDto GetCatalogRelationDto(string assetKey)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | assetKey | The asset key. |
Returns
| Type | Description |
|---|---|
| CatalogRelationDto |
GetCurrencyDto()
Gets the currency dto.
Declaration
CurrencyDto GetCurrencyDto()Returns
| Type | Description |
|---|---|
| CurrencyDto |
GetMerchantsDto()
Gets the merchants.
Declaration
CatalogEntryDto GetMerchantsDto()Returns
| Type | Description |
|---|---|
| CatalogEntryDto |
SaveAssociationType(CatalogAssociationDto)
Saves the catalog association type.
Declaration
void SaveAssociationType(CatalogAssociationDto dto)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogAssociationDto | dto | The dto. |
SaveCatalog(CatalogDto)
Saves the catalog.
Declaration
void SaveCatalog(CatalogDto dto)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogDto | dto | The dto. |
SaveCatalogAssociation(CatalogAssociationDto)
Saves the catalog association.
Declaration
void SaveCatalogAssociation(CatalogAssociationDto dto)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogAssociationDto | dto | The dto. |
SaveCatalogEntry(CatalogEntryDto)
Saves the catalog entry.
Declaration
void SaveCatalogEntry(CatalogEntryDto dto)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogEntryDto | dto | The dto. |
SaveCatalogNode(CatalogNodeDto)
Saves the catalog node.
Declaration
void SaveCatalogNode(CatalogNodeDto dto)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogNodeDto | dto | The dto. |
SaveCatalogRelationDto(CatalogRelationDto)
Saves the catalog relation dto.
Declaration
void SaveCatalogRelationDto(CatalogRelationDto dto)Parameters
| Type | Name | Description |
|---|---|---|
| CatalogRelationDto | dto | The dto. |
SaveCurrency(CurrencyDto)
Saves the currency.
Declaration
void SaveCurrency(CurrencyDto dto)Parameters
| Type | Name | Description |
|---|---|---|
| CurrencyDto | dto | The dto. |
StartFindItemsForIndexing(Guid, Int32, Boolean, Nullable<DateTime>, Nullable<DateTime>)
Initializes a catalog search for indexing.
Declaration
int StartFindItemsForIndexing(Guid searchSetId, int catalogId, bool isIncremental, DateTime? earliestModifiedDate, DateTime? latestModifiedDate)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | searchSetId | The identifier for the current search set. This will be passed back in to get results. |
| System.Int32 | catalogId | The catalog ID to search. |
| System.Boolean | isIncremental | if set to |
| System.Nullable<System.DateTime> | earliestModifiedDate | If non null, only entries with a modified date on or after this value will be included in the results. |
| System.Nullable<System.DateTime> | latestModifiedDate | If non null, only entries with a modified date on or before this value will be included in the results. |
Returns
| Type | Description |
|---|---|
| System.Int32 | A count of the number of items that will be returned in the result set. |
