Class TransactionAllocated

A helper class used for translating values held against an ITransactionAllocated

This is because transactions and transaction allocated records store their values in different value fields depending on the configuration of the ITransactionCode

Inheritance

System.Object

TransactionAllocated

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)

System.Object.ToString()

Namespace: LemonEdge.API.Entities.Helpers

Assembly: API.dll

Syntax

public class TransactionAllocated

Methods

GetFuncValue(ITransactionAllocated, Int16)

Returns the functional value for the specified transaction allocated record given the specified sequence which corresponds to a Sequence

Declaration

public static decimal GetFuncValue(ITransactionAllocated alloc, short sequence)

Parameters

Type	Name	Description
ITransactionAllocated	alloc	The record to return the specified functional value from
System.Int16	sequence	The sequence indicating the value to be retrieved as defined by the Sequence against the transactions transaction code

Returns

Type	Description
System.Decimal	The functional value for the specified transaction allocated record given the specified sequence which corresponds to a Sequence

GetLocalValue(ITransactionAllocated, Int16)

Returns the local value for the specified transaction allocated record given the specified sequence which corresponds to a Sequence

Declaration

public static decimal GetLocalValue(ITransactionAllocated alloc, short sequence)

Parameters

Type	Name	Description
ITransactionAllocated	alloc	The record to return the specified local value from
System.Int16	sequence	The sequence indicating the value to be retrieved as defined by the Sequence against the transactions transaction code

Returns

Type	Description
System.Decimal	The local value for the specified transaction allocated record given the specified sequence which corresponds to a Sequence

GetManualChange(ITransactionAllocated, Int16)

Returns if the specified value for the specified transaction allocated record was manually modified or calculated automatically

Declaration

public static bool GetManualChange(ITransactionAllocated transaction, short sequence)

Parameters

Type	Name	Description
ITransactionAllocated	transaction	The record to see if the value was manually modified on
System.Int16	sequence	The sequence indicating if the value was manually updated as defined by the Sequence against the transactions transaction code

Returns

Type	Description
System.Boolean	True if the value was manually updated, or false if it was done so automatically

GetReportingValue(ITransactionAllocated, Int16)

Returns the reporting value for the specified transaction allocated record given the specified sequence which corresponds to a Sequence

Declaration

public static decimal GetReportingValue(ITransactionAllocated alloc, short sequence)

Parameters

Type	Name	Description
ITransactionAllocated	alloc	The record to return the specified reporting value from
System.Int16	sequence	The sequence indicating the value to be retrieved as defined by the Sequence against the transactions transaction code

Returns

Type	Description
System.Decimal	The reporting value for the specified transaction allocated record given the specified sequence which corresponds to a Sequence

HasManualChange(ITransactionAllocated)

Returns true if any of the values have been manually updated by the user rather than all having been automatically calculated

Declaration

public static bool HasManualChange(ITransactionAllocated alloc)

Parameters

Type	Name	Description
ITransactionAllocated	alloc	The record to see if it has any manual changes

Returns

Type	Description
System.Boolean	True if any of the values have been manually updated by the user rather than all having been automatically calculated

SetFuncValue(ITransactionAllocated, Int16, Decimal)

Sets the functional value for the specified transaction allocated record given the specified sequence which corresponds to a Sequence

Declaration

public static void SetFuncValue(ITransactionAllocated alloc, short sequence, decimal value)

Parameters

Type	Name	Description
ITransactionAllocated	alloc	The record to modify the specified functional value of
System.Int16	sequence	The sequence indicating the value to be updated as defined by the Sequence against the transactions transaction code
System.Decimal	value	The value to update the functional value against the transaction allocated record with

SetLocalValue(ITransactionAllocated, Int16, Decimal)

Sets the local value for the specified transaction allocated record given the specified sequence which corresponds to a Sequence

Declaration

public static void SetLocalValue(ITransactionAllocated alloc, short sequence, decimal value)

Parameters

Type	Name	Description
ITransactionAllocated	alloc	The record to modify the specified local value of
System.Int16	sequence	The sequence indicating the value to be updated as defined by the Sequence against the transactions transaction code
System.Decimal	value	The value to update the local value against the transaction allocated record with

SetManualChange(ITransactionAllocated, Int16, Nullable<Boolean>)

Sets if the specified value for the specified transaction allocated record was manually modified or calculated automatically

Declaration

public static void SetManualChange(ITransactionAllocated transaction, short sequence, bool? value)

Parameters

Type	Name	Description
ITransactionAllocated	transaction	The record to update if the value was manually modified on
System.Int16	sequence	The sequence to indicate if the value was manually updated as defined by the Sequence against the transactions transaction code
System.Nullable<System.Boolean>	value

SetReportingValue(ITransactionAllocated, Int16, Decimal)

Sets the reporting value for the specified transaction allocated record given the specified sequence which corresponds to a Sequence

Declaration

public static void SetReportingValue(ITransactionAllocated alloc, short sequence, decimal value)

Parameters

Type	Name	Description
ITransactionAllocated	alloc	The record to modify the specified reporting value of
System.Int16	sequence	The sequence indicating the value to be updated as defined by the Sequence against the transactions transaction code
System.Decimal	value	The value to update the reporting value against the transaction allocated record with

Extension Methods

MiscExtensions.SetIfNotEqual<T, P>(T, Expression<Func<T, P>>, P)

ReflectionExtensions.ClearEventInvocations(Object, String)

StringExtensions.ToCSVFormatString(Object, Type)

SQLExtensions.ToSQLValue(Object, Boolean)

See Also

Transaction