Class ImportLineResultInfo

A class holding the details of an item that has been imported by the system

Inheritance
object
ImportLineResultInfo
Inherited Members
Namespace: LemonEdge.API.Core.Processors.Importing
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
public class ImportLineResultInfo

Constructors

ImportLineResultInfo(int)

Creates a new class holding the result of this import with the specified line number

Declaration
public ImportLineResultInfo(int rowNumber)
Parameters
Type Name Description
int rowNumber

The line number this import represents.

Properties

Action

Holds the type of update that was applied to the item being imported

Declaration
public ImportResultAction Action { get; set; }
Property Value
Type Description
ImportResultAction

AllowOpen

Indicates if the client UI should allow opening of this imported item

Declaration
public bool AllowOpen { get; set; }
Property Value
Type Description
bool

AutoCreatedTaskID

Declaration
public Guid? AutoCreatedTaskID { get; set; }
Property Value
Type Description
Guid?

Error

A message holding any errors of the import

Declaration
public string Error { get; set; }
Property Value
Type Description
string

HadChanges

Indicates if there were any changes from the existing item and the data being imported

Declaration
public bool HadChanges { get; set; }
Property Value
Type Description
bool

ID

The unique global id of the entity that was updated by this import

Declaration
public Guid ID { get; set; }
Property Value
Type Description
Guid

ImportStep

If this import was contained within an IImportDefinition, this holds the step

Declaration
public string ImportStep { get; set; }
Property Value
Type Description
string

Item

The actual item that was imported/deleted/updated

Declaration
public IBaseEntity Item { get; set; }
Property Value
Type Description
IBaseEntity

LineNumber

The line number this import result is associated with

Declaration
public int LineNumber { get; }
Property Value
Type Description
int

Message

A message relating to the status of the import

Declaration
public string Message { get; set; }
Property Value
Type Description
string

Type

The unique global id of the type of the entity that was updated by this import

Declaration
public Guid Type { get; set; }
Property Value
Type Description
Guid

Methods

GetResultSummary(IEntityRetriever, string, IEnumerable<ImportLineResultInfo>, Func<EntityDescriptor, int, Task>, Action<IEnumerable<ImportLineResultInfo>>)

Declaration
public static Task<(StringBuilder msg, IEnumerable<ImportLineResultInfo> errors)> GetResultSummary(IEntityRetriever retriever, string actionMsg, IEnumerable<ImportLineResultInfo> results, Func<EntityDescriptor, int, Task> addToOpenableTypes, Action<IEnumerable<ImportLineResultInfo>> addToItemsWithTasks)
Parameters
Type Name Description
IEntityRetriever retriever
string actionMsg
IEnumerable<ImportLineResultInfo> results
Func<EntityDescriptor, int, Task> addToOpenableTypes
Action<IEnumerable<ImportLineResultInfo>> addToItemsWithTasks
Returns
Type Description
Task<(StringBuilder msg, IEnumerable<ImportLineResultInfo> errors)>

SetError(Exception)

If an error is encountered while importing the data, this sets the error

Declaration
public void SetError(Exception error)
Parameters
Type Name Description
Exception error

The error encountered while importing this data

ToString()

The user friendly string of the status of this item being imported

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

ToStringWithSaveState(bool)

Indicates the results of this line import

Declaration
public string ToStringWithSaveState(bool savePending)
Parameters
Type Name Description
bool savePending

Indicates if the save was committed after this line as part of a batch process
Returns
Type Description
string

The user friendly string of the status of this item being imported

Extension Methods