Class CatalogImportExport

Implements operations for catalog import and export.

Inheritance

System.Object

CatalogImportExport

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Mediachase.Commerce.Catalog.ImportExport

Assembly: Mediachase.Commerce.dll

Version: 13.30.0

Syntax

public class CatalogImportExport

Constructors

CatalogImportExport()

Initializes a new instance of the CatalogImportExport class.

Declaration

public CatalogImportExport()

CatalogImportExport(ICatalogSystem, IPriceService, IWarehouseRepository, IInventoryService, CatalogItemAssetImportExport, UniqueSeoGenerator, ContentGuidAdmin, EntryIdentityResolver, NodeIdentityResolver, IConnectionStringHandler)

Initializes a new instance of the CatalogImportExport class.

Declaration

[Obsolete("Use constructor with Internal.ContentGuidAdmin instead. Will remain at least until Aug 2020.")]
public CatalogImportExport(ICatalogSystem catalogSystem, IPriceService priceService, IWarehouseRepository warehouseRepository, IInventoryService inventoryService, CatalogItemAssetImportExport assetImportExport, UniqueSeoGenerator uniqueSeoGenerator, ContentGuidAdmin contentGuidAdmin, EntryIdentityResolver entryIdentityResolver, NodeIdentityResolver nodeIdentityResolver, IConnectionStringHandler connectionHandler)

Parameters

Type	Name	Description
ICatalogSystem	catalogSystem
IPriceService	priceService
IWarehouseRepository	warehouseRepository
IInventoryService	inventoryService
CatalogItemAssetImportExport	assetImportExport
UniqueSeoGenerator	uniqueSeoGenerator
ContentGuidAdmin	contentGuidAdmin
EntryIdentityResolver	entryIdentityResolver
NodeIdentityResolver	nodeIdentityResolver
IConnectionStringHandler	connectionHandler

CatalogImportExport(ICatalogSystem, IPriceService, IWarehouseRepository, IInventoryService, CatalogItemAssetImportExport, UniqueSeoGenerator, ContentGuidAdmin, EntryIdentityResolver, NodeIdentityResolver, IConnectionStringHandler)

Initializes a new instance of the CatalogImportExport class.

Declaration

public CatalogImportExport(ICatalogSystem catalogSystem, IPriceService priceService, IWarehouseRepository warehouseRepository, IInventoryService inventoryService, CatalogItemAssetImportExport assetImportExport, UniqueSeoGenerator uniqueSeoGenerator, ContentGuidAdmin contentGuidAdmin, EntryIdentityResolver entryIdentityResolver, NodeIdentityResolver nodeIdentityResolver, IConnectionStringHandler connectionHandler)

Parameters

Type	Name	Description
ICatalogSystem	catalogSystem
IPriceService	priceService
IWarehouseRepository	warehouseRepository
IInventoryService	inventoryService
CatalogItemAssetImportExport	assetImportExport
UniqueSeoGenerator	uniqueSeoGenerator
ContentGuidAdmin	contentGuidAdmin
EntryIdentityResolver	entryIdentityResolver
NodeIdentityResolver	nodeIdentityResolver
IConnectionStringHandler	connectionHandler

Properties

IsModelsAvailable

Gets or sets a value indicating whether the strongly typed models are available in the current context.
The default value is true

Declaration

public bool IsModelsAvailable { get; set; }

Property Value

Type	Description
System.Boolean	`true` if this instance is models available; otherwise, `false`.

MetaDataContextClone

Gets the meta data context clone.

Declaration

protected MetaDataContext MetaDataContextClone { get; }

Property Value

Type	Description
MetaDataContext	The meta data context clone.

Methods

Export(String, Stream, String)

Exports the specified catalog name.

Declaration

public void Export(string catalogName, Stream output, string baseFilePath)

Parameters

Type	Name	Description
System.String	catalogName	Name of the catalog.
System.IO.Stream	output	The output.
System.String	baseFilePath	The base file path.

Import(Stream, Boolean)

Imports one or many catalogs, metadata and dictionaries from an xml source.

Declaration

public void Import(Stream stream, bool overwrite)

Parameters

Type	Name	Description
System.IO.Stream	stream	The xml file stream from where xml data is read.
System.Boolean	overwrite	A flag to indicate whether or not existing items should be overwritten.

Import(String, Boolean)

Imports one or many catalogs, metadata and dictionaries from an xml source.

Declaration

public void Import(string directoryPath, bool overwrite)

Parameters

Type	Name	Description
System.String	directoryPath	The directory of the extracted zip content.
System.Boolean	overwrite	A flag to indicate whether or not existing items should be overwritten.

OnImportExportProgressMessage(Object, ImportExportEventArgs)

Raises the ImportExportProgressMessage event.

Declaration

protected virtual void OnImportExportProgressMessage(object source, ImportExportEventArgs args)

Parameters

Type	Name	Description
System.Object	source	The source.
ImportExportEventArgs	args	The ImportExportEventArgs instance containing the event data.

Events

ImportExportProgressMessage

Occurs when [import export progress message].

Declaration

public event ImportExportProgressMessageHandler ImportExportProgressMessage

Event Type

Type	Description
ImportExportProgressMessageHandler