Class BasePortableService

A abstract class specifying the ability to import and export site different areas.

Inheritance

System.Object

BasePortableService

AssetsExportService

PackagesExportService

PagesExportService

PortalExportService

ProfilePropertiesService

RolesExportService

ThemesExportService

UsersDataExportService

UsersExportService

VocabularyService

WorkflowsExportService

Namespace: Dnn.ExportImport.Components.Services

Assembly: DotNetNuke.SiteExportImport.dll

Syntax

public abstract class BasePortableService : object

Properties

Category

Gets category name for the exportable module. For example: "ASSETS".

Declaration

public abstract string Category { get; }

Property Value

Type	Description
System.String

CheckCancelled

Gets or sets a callback to the export/import engine to check if the undergoing export/import process was cancelled.

The interface concrete classes should keep checking continuously for the cancellation flag to be true.

If the callback returns true, the BasePortableService implementations should stop any work they do and return control to the caller immediately or as soon as possible.

Declaration

public Func<ExportImportJob, bool> CheckCancelled { get; set; }

Property Value

Type	Description
Func<ExportImportJob, System.Boolean>

CheckPoint

Gets or sets a data structure representing a checkpoint for the export/import task. This can be used to tell the implementor where to resume it's operation if the job was interrupted previously.

Declaration

public ExportImportChekpoint CheckPoint { get; set; }

Property Value

Type	Description
ExportImportChekpoint

Remarks

It is up to each BasePortableService implementor to track its own stages and status values to properly export/import all of its items in/when and interruption occurs.

CheckPointStageCallback

Gets or sets callback function to provide a checkpoint mechanism for an BasePortableService implementation. The actual method shoul persist the reported checkpoint in the engine so if the process is interrupted, it can be resumed. If the reponse to calling this function was false, then the task should stop processing and return control immediately to the caller.

Declaration

public Func<BasePortableService, bool> CheckPointStageCallback { get; set; }

Property Value

Type	Description
Func<BasePortableService, System.Boolean>	True if the implementation to abort progress; false to continue.

ParentCategory

Gets category name for the parent exportable module. For example: "USERS". If this is null, then the category is a top parent. If this is not null, then this category will be included automatically when the parent is included.

Declaration

public abstract string ParentCategory { get; }

Property Value

Type	Description
System.String

Priority

Gets a priority for exporting/importing the object. Objects with higher priority are exported/imported first. Highest priority is 0.

Declaration

public abstract uint Priority { get; }

Property Value

Type	Description
System.UInt32

Repository

Gets or sets a repository to store exported items in and to retrieve from upon import.

Declaration

public IExportImportRepository Repository { get; set; }

Property Value

Type	Description
IExportImportRepository

Result

Gets or sets an object to record the export/import progress information. This is set by the export/import engine.

Declaration

public ExportImportResult Result { get; set; }

Property Value

Type	Description
ExportImportResult

Methods

ExportData(ExportImportJob, ExportDto)

A abstract class specifying the ability to import and export site different areas.

Declaration

public abstract void ExportData(ExportImportJob exportJob, ExportDto exportDto)

Parameters

Type	Name	Description
ExportImportJob	exportJob
ExportDto	exportDto

GetImportTotal()

A abstract class specifying the ability to import and export site different areas.

Declaration

public abstract int GetImportTotal()

Returns

Type	Description
System.Int32

ImportData(ExportImportJob, ImportDto)

A abstract class specifying the ability to import and export site different areas.

Declaration

public abstract void ImportData(ExportImportJob importJob, ImportDto importDto)

Parameters

Type	Name	Description
ExportImportJob	importJob
ImportDto	importDto

Extension Methods

JsonExtensionsWeb.ToJson(Object)