[DataContract]
public class StepChange : BaseEntityWithPermissions, IStepChange, IHeaderTransactionalEntity, IBaseEntityWithPermissions, ITransactionalEntity, ICanBeLocked, IHasReference, IHasSaveProcessingTask, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IStepChange>

Constructors

StepChange()

Declaration

public StepChange()

Properties

CancelledID

Holds the original transactional entity record this record is cancelling.

Declaration

public Guid? CancelledID { get; set; }

Property Value

Type	Description
Guid?

CancelledID_Label

Declaration

public string CancelledID_Label { get; set; }

Property Value

Type	Description
string

CancelledID_Label_Silent

Declaration

[NotMapped]
public string CancelledID_Label_Silent { get; set; }

Property Value

Type	Description
string

CorrectedByID

Holds the new transactional entity record this record is corrected by, if any.

Declaration

public Guid? CorrectedByID { get; set; }

Property Value

Type	Description
Guid?

CorrectedByID_Label

Declaration

public string CorrectedByID_Label { get; set; }

Property Value

Type	Description
string

CorrectedByID_Label_Silent

Declaration

[NotMapped]
public string CorrectedByID_Label_Silent { get; set; }

Property Value

Type	Description
string

Description

A short user friendly description of this transaction.

Declaration

[StringLength(200)]
public string Description { get; set; }

Property Value

Type	Description
string

EntitySetID

Links to IEntitySet. The Entity Set this Step Change is taking place within. All affected allocations within this entity set will be modified according to the setup

Declaration

[RequiredNoDefaultIDValidation]
public Guid EntitySetID { get; set; }

Property Value

Type	Description
Guid

EntitySetID_Label

Declaration

public string EntitySetID_Label { get; set; }

Property Value

Type	Description
string

EntitySetID_Label_Silent

Declaration

[NotMapped]
public string EntitySetID_Label_Silent { get; set; }

Property Value

Type	Description
string

Locked

Indicates the current record is locked and can not be modified until it is unlocked.

Declaration

[Required]
public bool Locked { get; set; }

Property Value

Type	Description
bool

PriorRunTaskParam

Holds the task parameters used when this was previously run. SavedTaskParam is cleared after processing to distinguish between imports and other operations.

Declaration

public byte[] PriorRunTaskParam { get; set; }

Property Value

Type	Description
byte[]

Reference

The auto-increment unique reference for this entity

Declaration

public int Reference { get; set; }

Property Value

Type	Description
int

SavedTaskID

Links to IServerTask. Indicates the task that has been automatically created during the save process for completing any further processing

Declaration

public Guid? SavedTaskID { get; set; }

Property Value

Type	Description
Guid?

SavedTaskID_Label

Declaration

public string SavedTaskID_Label { get; set; }

Property Value

Type	Description
string

SavedTaskID_Label_Silent

Declaration

[NotMapped]
public string SavedTaskID_Label_Silent { get; set; }

Property Value

Type	Description
string

SavedTaskParam

Holds the associated parameters for the task SavedTaskID

Declaration

public byte[] SavedTaskParam { get; set; }

Property Value

Type	Description
byte[]

Status

Indicates the current status of this transactional object.

By default GL entries aren't processed until an entity has a status >= Committed.

Finalazied transactions can only be modified through cancel/correct logic

Declaration

[EnumDataType(typeof(TransactionStatus))]
public TransactionStatus Status { get; set; }

Property Value

Type	Description
TransactionStatus

Declaration

[NotMapped]
public string Status_Tooltip { get; set; }

Property Value

Type	Description
string

StepDate

The closing date the step change should be calculated for, if different from the transaction date. The transaction date is used for the actual date the transactions are created for.

Declaration

public DateTimeOffset StepDate { get; set; }

Property Value

Type	Description
DateTimeOffset

TransactionDate

The transaction date of this transaction.

Declaration

[RequiredNoDefaultIDValidation]
public DateTimeOffset TransactionDate { get; set; }

Property Value

Type	Description
DateTimeOffset

Methods

CopyFromEntity(IBaseEntity)

Declaration

protected override void CopyFromEntity(IBaseEntity src)

Parameters

Type	Name	Description
IBaseEntity	src

Overrides

BaseEntity.CopyFromEntity(IBaseEntity)

CopyFromSource(IStepChange)

Updates all properties in this item to have the same properties as the source object.

Declaration

public void CopyFromSource(IStepChange source)

Parameters

Type	Name	Description
IStepChange	source	The source object to copy all values from.

GetShouldAutoGenerateTaskOnSave()

Indicates if the task should automatically be generated on save

Only runs on the service, or directly connected to db. Defaults to true

So ensure processors that implement IBaseDataSetProcessorWithDBSave correctly set this for the task to be auto created or not on save

Declaration

public bool GetShouldAutoGenerateTaskOnSave()

Returns

Type	Description
bool	If the task should automatically be generated on save

SetAutoGenerateOnSave(bool)

Sets if thie task should be generated for this item on save or not

Declaration

public void SetAutoGenerateOnSave(bool value)

Parameters

Type	Name	Description
bool	value	Indicates if the task should be generated on save or not

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string