Class NSCurrencyEntity
Carrier object for CurrencyEntity.
Syntax
Constructors
NSCurrencyEntity()
Initializes a new instance of the NSCurrencyEntity class.
Declaration
NSCurrencyEntity
Methods
GetCurrencyId()
Carrier object for CurrencyEntity.
Declaration
Integer GetCurrencyId()
Returns
Type | Description |
---|---|
Integer | Primary key. |
Examples
NSCurrencyEntity thing;
Integer currencyId = thing.GetCurrencyId();
GetDeleted()
Carrier object for CurrencyEntity.
Declaration
Bool GetDeleted()
Returns
Type | Description |
---|---|
Bool | 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists. |
Examples
NSCurrencyEntity thing;
Bool deleted = thing.GetDeleted();
GetName()
Carrier object for CurrencyEntity.
Declaration
String GetName()
Returns
Type | Description |
---|---|
String | The list item. |
Examples
NSCurrencyEntity thing;
String name = thing.GetName();
GetRank()
Carrier object for CurrencyEntity.
Declaration
Integer GetRank()
Returns
Type | Description |
---|---|
Integer | Rank order. |
Examples
NSCurrencyEntity thing;
Integer rank = thing.GetRank();
GetRate()
Carrier object for CurrencyEntity.
Declaration
Float GetRate()
Returns
Type | Description |
---|---|
Float | Exchange rate. |
Examples
NSCurrencyEntity thing;
Float rate = thing.GetRate();
GetTooltip()
Carrier object for CurrencyEntity.
Declaration
String GetTooltip()
Returns
Type | Description |
---|---|
String | Tooltip or other description. |
Examples
NSCurrencyEntity thing;
String tooltip = thing.GetTooltip();
GetUnits()
Carrier object for CurrencyEntity.
Declaration
Float GetUnits()
Returns
Type | Description |
---|---|
Float | Exchange unit scale (0.01, 0.1, 1, 10, 100 etc). |
Examples
NSCurrencyEntity thing;
Float units = thing.GetUnits();
SetCurrencyId(Integer)
Carrier object for CurrencyEntity.
Declaration
Void SetCurrencyId(Integer currencyId)
Parameters
Type | Name | Description |
---|---|---|
Integer | currencyId | Primary key. |
Returns
Type | Description |
---|---|
Void |
Examples
NSCurrencyEntity thing;
Integer currencyId;
thing.SetCurrencyId(currencyId);
SetDeleted(Bool)
Carrier object for CurrencyEntity.
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
NSCurrencyEntity thing;
Bool deleted;
thing.SetDeleted(deleted);
SetName(String)
Carrier object for CurrencyEntity.
Declaration
Void SetName(String name)
Parameters
Type | Name | Description |
---|---|---|
String | name | The list item. |
Returns
Type | Description |
---|---|
Void |
Examples
NSCurrencyEntity thing;
String name;
thing.SetName(name);
SetRank(Integer)
Carrier object for CurrencyEntity.
Declaration
Void SetRank(Integer rank)
Parameters
Type | Name | Description |
---|---|---|
Integer | rank | Rank order. |
Returns
Type | Description |
---|---|
Void |
Examples
NSCurrencyEntity thing;
Integer rank;
thing.SetRank(rank);
SetRate(Float)
Carrier object for CurrencyEntity.
Declaration
Void SetRate(Float rate)
Parameters
Type | Name | Description |
---|---|---|
Float | rate | Exchange rate. |
Returns
Type | Description |
---|---|
Void |
Examples
NSCurrencyEntity thing;
Float rate;
thing.SetRate(rate);
SetTooltip(String)
Carrier object for CurrencyEntity.
Declaration
Void SetTooltip(String tooltip)
Parameters
Type | Name | Description |
---|---|---|
String | tooltip | Tooltip or other description. |
Returns
Type | Description |
---|---|
Void |
Examples
NSCurrencyEntity thing;
String tooltip;
thing.SetTooltip(tooltip);
SetUnits(Float)
Carrier object for CurrencyEntity.
Declaration
Void SetUnits(Float units)
Parameters
Type | Name | Description |
---|---|---|
Float | units | Exchange unit scale (0.01, 0.1, 1, 10, 100 etc). |
Returns
Type | Description |
---|---|
Void |
Examples
NSCurrencyEntity thing;
Float units;
thing.SetUnits(units);