Class NSAmountClassEntity

Carrier object for AmountClassEntity.

Syntax

Constructors

NSAmountClassEntity()

Initializes a new instance of the NSAmountClassEntity class.

Introduced or updated in version: 7.5

Declaration

NSAmountClassEntity

Methods

GetAmountClassId()

Introduced or updated in version: 7.5

Declaration

Integer GetAmountClassId()

Returns

Type	Description
Integer	Primary key.

Examples

NSAmountClassEntity thing;
Integer amountClassId = thing.GetAmountClassId();

GetAmountFrom()

Introduced or updated in version: 7.5

Declaration

Float GetAmountFrom()

Returns

Type	Description
Float	Lower limit of this amount class.

Examples

NSAmountClassEntity thing;
Float amountFrom = thing.GetAmountFrom();

GetAmountTo()

Introduced or updated in version: 7.5

Declaration

Float GetAmountTo()

Returns

Type	Description
Float	Upper limit of this amount class.

Examples

NSAmountClassEntity thing;
Float amountTo = thing.GetAmountTo();

GetCurrencyId()

Introduced or updated in version: 7.5

Declaration

Integer GetCurrencyId()

Returns

Type	Description
Integer	Currency the limits in this amount class refer to.

Remarks

Mixing currencies between classes can give rise to overlapping intervals and thus unpredictable classifications.

Examples

NSAmountClassEntity thing;
Integer currencyId = thing.GetCurrencyId();

GetDeleted()

Introduced or updated in version: 7.5

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	0 - record is active; 1 - record is deleted and should not be shown in lists.

Examples

NSAmountClassEntity thing;
Bool deleted = thing.GetDeleted();

GetName()

Introduced or updated in version: 7.5

Declaration

String GetName()

Returns

Type	Description
String	The list item.

Examples

NSAmountClassEntity thing;
String name = thing.GetName();

GetRank()

Introduced or updated in version: 7.5

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank order.

Examples

NSAmountClassEntity thing;
Integer rank = thing.GetRank();

GetTooltip()

Introduced or updated in version: 7.5

Declaration

String GetTooltip()

Returns

Type	Description
String	Tooltip or other description.

Examples

NSAmountClassEntity thing;
String tooltip = thing.GetTooltip();

SetAmountClassId(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetAmountClassId(Integer amountClassId)

Parameters

Type	Name	Description
Integer	amountClassId	Primary key.

Returns

Type	Description
Void

Examples

NSAmountClassEntity thing;
Integer amountClassId;
thing.SetAmountClassId(amountClassId);

SetAmountFrom(Float)

Introduced or updated in version: 7.5

Declaration

Void SetAmountFrom(Float amountFrom)

Parameters

Type	Name	Description
Float	amountFrom	Lower limit of this amount class.

Returns

Type	Description
Void

Examples

NSAmountClassEntity thing;
Float amountFrom;
thing.SetAmountFrom(amountFrom);

SetAmountTo(Float)

Introduced or updated in version: 7.5

Declaration

Void SetAmountTo(Float amountTo)

Parameters

Type	Name	Description
Float	amountTo	Upper limit of this amount class.

Returns

Type	Description
Void

Examples

NSAmountClassEntity thing;
Float amountTo;
thing.SetAmountTo(amountTo);

SetCurrencyId(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetCurrencyId(Integer currencyId)

Parameters

Type	Name	Description
Integer	currencyId	Currency the limits in this amount class refer to.

Returns

Type	Description
Void

Remarks

Mixing currencies between classes can give rise to overlapping intervals and thus unpredictable classifications.

Examples

NSAmountClassEntity thing;
Integer currencyId;
thing.SetCurrencyId(currencyId);

SetDeleted(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	0 - record is active; 1 - record is deleted and should not be shown in lists.

Returns

Type	Description
Void

Examples

NSAmountClassEntity thing;
Bool deleted;
thing.SetDeleted(deleted);

SetName(String)

Introduced or updated in version: 7.5

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The list item.

Returns

Type	Description
Void

Examples

NSAmountClassEntity thing;
String name;
thing.SetName(name);

SetRank(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Rank order.

Returns

Type	Description
Void

Examples

NSAmountClassEntity thing;
Integer rank;
thing.SetRank(rank);

SetTooltip(String)

Introduced or updated in version: 7.5

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	Tooltip or other description.

Returns

Type	Description
Void

Examples

NSAmountClassEntity thing;
String tooltip;
thing.SetTooltip(tooltip);