Class ImportLineResultInfo

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

Inheritance
System.Object
ImportLineResultInfo
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: LemonEdge.Entities.Processors.Importing
Assembly: API.dll
Syntax
[DataContract]
public class ImportLineResultInfo

Constructors

ImportLineResultInfo(Int32)

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

Declaration
public ImportLineResultInfo(int rowNumber)
Parameters
Type Name Description
System.Int32 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
System.Boolean

AutoCreatedTaskID

Declaration
public Guid? AutoCreatedTaskID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

Error

A message holding any errors of the import

Declaration
public string Error { get; set; }
Property Value
Type Description
System.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
System.Boolean

ID

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

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

ImportStep

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

Declaration
public string ImportStep { get; set; }
Property Value
Type Description
System.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
System.Int32

Message

A message relating to the status of the import

Declaration
public string Message { get; set; }
Property Value
Type Description
System.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
System.Guid

Methods

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
System.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
System.String
Overrides
System.Object.ToString()

ToStringWithSaveState(Boolean)

Indicates the results of this line import

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

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

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

Extension Methods