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: 10.8.0
Syntax
public class CatalogImportExport

Constructors

CatalogImportExport()

Initializes a new instance of the CatalogImportExport class.

Declaration
public CatalogImportExport()

CatalogImportExport(ICatalogSystem, IPriceService, IWarehouseRepository, IWarehouseInventoryService)

Initializes a new instance of the CatalogImportExport class.

Declaration
[Obsolete("This constructor was obsoleted, will remain at least until March 2016.")]
public CatalogImportExport(ICatalogSystem catalogSystem, IPriceService priceService, IWarehouseRepository warehouseRepository, IWarehouseInventoryService inventoryService)
Parameters
Type Name Description
ICatalogSystem catalogSystem
IPriceService priceService
IWarehouseRepository warehouseRepository
IWarehouseInventoryService inventoryService

CatalogImportExport(ICatalogSystem, IPriceService, IWarehouseRepository, IWarehouseInventoryService, ReferenceConverter, CatalogItemAssetImportExport, ContentGuidAdmin)

Initializes a new instance of the CatalogImportExport class.

Declaration
[Obsolete("This constructor was obsoleted, will remain at least until August 2016.")]
public CatalogImportExport(ICatalogSystem catalogSystem, IPriceService priceService, IWarehouseRepository warehouseRepository, IWarehouseInventoryService inventoryService, ReferenceConverter referenceConverter, CatalogItemAssetImportExport assetImportExport, ContentGuidAdmin contentGuidAdmin)
Parameters
Type Name Description
ICatalogSystem catalogSystem
IPriceService priceService
IWarehouseRepository warehouseRepository
IWarehouseInventoryService inventoryService
ReferenceConverter referenceConverter
CatalogItemAssetImportExport assetImportExport
ContentGuidAdmin contentGuidAdmin

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

Initializes a new instance of the CatalogImportExport class.

Declaration
[Obsolete("This constructor was obsoleted, will remain at least until August 2017.")]
public CatalogImportExport(ICatalogSystem catalogSystem, IPriceService priceService, IWarehouseRepository warehouseRepository, IInventoryService inventoryService, CatalogItemAssetImportExport assetImportExport, UniqueSeoGenerator uniqueSeoGenerator, ContentGuidAdmin contentGuidAdmin, EntryIdentityResolver entryIdentityResolver, NodeIdentityResolver nodeIdentityResolver)
Parameters
Type Name Description
ICatalogSystem catalogSystem
IPriceService priceService
IWarehouseRepository warehouseRepository
IInventoryService inventoryService
CatalogItemAssetImportExport assetImportExport
UniqueSeoGenerator uniqueSeoGenerator
ContentGuidAdmin contentGuidAdmin
EntryIdentityResolver entryIdentityResolver
NodeIdentityResolver nodeIdentityResolver

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

CatalogImportExport(ICatalogSystem, IPriceService, IWarehouseRepository, IInventoryService, ReferenceConverter, CatalogItemAssetImportExport)

Initializes a new instance of the CatalogImportExport class.

Declaration
[Obsolete("This constructor was obsoleted, will remain at least until July 2016.")]
public CatalogImportExport(ICatalogSystem catalogSystem, IPriceService priceService, IWarehouseRepository warehouseRepository, IInventoryService inventoryService, ReferenceConverter referenceConverter, CatalogItemAssetImportExport assetImportExport)
Parameters
Type Name Description
ICatalogSystem catalogSystem
IPriceService priceService
IWarehouseRepository warehouseRepository
IInventoryService inventoryService
ReferenceConverter referenceConverter
CatalogItemAssetImportExport assetImportExport

CatalogImportExport(ICatalogSystem, IPriceService, IWarehouseRepository, IInventoryService, ReferenceConverter, CatalogItemAssetImportExport, UniqueSeoGenerator, ContentGuidAdmin)

Initializes a new instance of the CatalogImportExport class.

Declaration
[Obsolete("This constructor was obsoleted, will remain at least until February 2017.")]
public CatalogImportExport(ICatalogSystem catalogSystem, IPriceService priceService, IWarehouseRepository warehouseRepository, IInventoryService inventoryService, ReferenceConverter referenceConverter, CatalogItemAssetImportExport assetImportExport, UniqueSeoGenerator uniqueSeoGenerator, ContentGuidAdmin contentGuidAdmin)
Parameters
Type Name Description
ICatalogSystem catalogSystem
IPriceService priceService
IWarehouseRepository warehouseRepository
IInventoryService inventoryService
ReferenceConverter referenceConverter
CatalogItemAssetImportExport assetImportExport
UniqueSeoGenerator uniqueSeoGenerator
ContentGuidAdmin contentGuidAdmin

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

Initializes a new instance of the CatalogImportExport class.

Declaration
[Obsolete("This constructor was obsoleted, will remain at least until April 2017.")]
public CatalogImportExport(ICatalogSystem catalogSystem, IPriceService priceService, IWarehouseRepository warehouseRepository, IInventoryService inventoryService, ReferenceConverter referenceConverter, CatalogItemAssetImportExport assetImportExport, UniqueSeoGenerator uniqueSeoGenerator, ContentGuidAdmin contentGuidAdmin, EntryIdentityResolver entryIdentityResolver)
Parameters
Type Name Description
ICatalogSystem catalogSystem
IPriceService priceService
IWarehouseRepository warehouseRepository
IInventoryService inventoryService
ReferenceConverter referenceConverter
CatalogItemAssetImportExport assetImportExport
UniqueSeoGenerator uniqueSeoGenerator
ContentGuidAdmin contentGuidAdmin
EntryIdentityResolver entryIdentityResolver

Properties

ContactGroupNames

Gets or sets the contact group names.

Declaration
protected IEnumerable<string> ContactGroupNames { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

The contact group names.

ContactGroupType

Gets the type of the contact group.

Declaration
protected MetaFieldType ContactGroupType { get; }
Property Value
Type Description
MetaFieldType

The type of the contact group.

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.

GetTotalExportSteps()

Gets the total export steps.

Declaration
public static int GetTotalExportSteps()
Returns
Type Description
System.Int32

GetTotalImportSteps()

Gets the total import steps.

Declaration
public static int GetTotalImportSteps()
Returns
Type Description
System.Int32

Import(Stream, Guid, String)

Imports the specified input.

Declaration
public void Import(Stream input, Guid applicationId, string baseFilePath)
Parameters
Type Name Description
System.IO.Stream input

The input.

System.Guid applicationId

The application id.

System.String baseFilePath

The base file path.

Import(Stream, Guid, String, Boolean)

Imports the specified input.

Declaration
public void Import(Stream input, Guid applicationId, string baseFilePath, bool overwrite)
Parameters
Type Name Description
System.IO.Stream input

The input.

System.Guid applicationId

The application id.

System.String baseFilePath

The base file path.

System.Boolean overwrite

Overwrite existing entries.

metaInstaller_ImportExportProgressMessage(Object, String)

Declaration
public void metaInstaller_ImportExportProgressMessage(object source, string message)
Parameters
Type Name Description
System.Object source
System.String message

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