Class NSRefCountEntity
A refcount entity for a number allocation.
Syntax
Constructors
NSRefCountEntity()
Initializes a new instance of the NSRefCountEntity class.
Declaration
NSRefCountEntity
Methods
GetAllocate()
A refcount entity for a number allocation.
Declaration
Bool GetAllocate()
Returns
Type | Description |
---|---|
Bool | Allocate numbers automatically. |
Examples
NSRefCountEntity thing;
Bool allocate = thing.GetAllocate();
GetAllowBlank()
A refcount entity for a number allocation.
Declaration
Bool GetAllowBlank()
Returns
Type | Description |
---|---|
Bool | Allow blank as a valid value. |
Examples
NSRefCountEntity thing;
Bool allowBlank = thing.GetAllowBlank();
GetCurrentValue()
A refcount entity for a number allocation.
Declaration
Integer GetCurrentValue()
Returns
Type | Description |
---|---|
Integer | Current value of counter. |
Examples
NSRefCountEntity thing;
Integer currentValue = thing.GetCurrentValue();
GetField()
A refcount entity for a number allocation.
Declaration
String GetField()
Returns
Type | Description |
---|---|
String | Field identifier in string format table.field. |
Examples
NSRefCountEntity thing;
String field = thing.GetField();
GetReadOnly()
A refcount entity for a number allocation.
Declaration
Bool GetReadOnly()
Returns
Type | Description |
---|---|
Bool | Target field is read only in GUi. |
Examples
NSRefCountEntity thing;
Bool readOnly = thing.GetReadOnly();
GetRecordId()
A refcount entity for a number allocation.
Declaration
Integer GetRecordId()
Returns
Type | Description |
---|---|
Integer | Record ID in target table, used when there are separate counters for each target record. |
Examples
NSRefCountEntity thing;
Integer recordId = thing.GetRecordId();
GetRefCountsId()
A refcount entity for a number allocation.
Declaration
Integer GetRefCountsId()
Returns
Type | Description |
---|---|
Integer | Primary key. |
Examples
NSRefCountEntity thing;
Integer refCountsId = thing.GetRefCountsId();
GetSatPrefix()
A refcount entity for a number allocation.
Declaration
Integer GetSatPrefix()
Returns
Type | Description |
---|---|
Integer | size of prefix for Satellite use of this counter. |
Examples
NSRefCountEntity thing;
Integer satPrefix = thing.GetSatPrefix();
GetSuggestedRecords()
A refcount entity for a number allocation.
Declaration
NSMDOListItem[] GetSuggestedRecords()
Returns
Type | Description |
---|---|
NSMDOListItem[] | List of valid entities, the associated record is selected in the list, used records are filtered out. |
Examples
NSRefCountEntity thing;
NSMDOListItem[] suggestedRecords = thing.GetSuggestedRecords();
GetTravelPrefix()
A refcount entity for a number allocation.
Declaration
Integer GetTravelPrefix()
Returns
Type | Description |
---|---|
Integer | size of prefix for Travel use of ths counter. |
Examples
NSRefCountEntity thing;
Integer travelPrefix = thing.GetTravelPrefix();
GetUnique()
Checks that entered value is unique
Declaration
Bool GetUnique()
Returns
Type | Description |
---|---|
Bool |
Examples
NSRefCountEntity thing;
Bool unique = thing.GetUnique();
SetAllocate(Bool)
A refcount entity for a number allocation.
Declaration
Void SetAllocate(Bool allocate)
Parameters
Type | Name | Description |
---|---|---|
Bool | allocate | Allocate numbers automatically. |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
Bool allocate;
thing.SetAllocate(allocate);
SetAllowBlank(Bool)
A refcount entity for a number allocation.
Declaration
Void SetAllowBlank(Bool allowBlank)
Parameters
Type | Name | Description |
---|---|---|
Bool | allowBlank | Allow blank as a valid value. |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
Bool allowBlank;
thing.SetAllowBlank(allowBlank);
SetCurrentValue(Integer)
A refcount entity for a number allocation.
Declaration
Void SetCurrentValue(Integer currentValue)
Parameters
Type | Name | Description |
---|---|---|
Integer | currentValue | Current value of counter. |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
Integer currentValue;
thing.SetCurrentValue(currentValue);
SetField(String)
A refcount entity for a number allocation.
Declaration
Void SetField(String field)
Parameters
Type | Name | Description |
---|---|---|
String | field | Field identifier in string format table.field. |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
String field;
thing.SetField(field);
SetReadOnly(Bool)
A refcount entity for a number allocation.
Declaration
Void SetReadOnly(Bool readOnly)
Parameters
Type | Name | Description |
---|---|---|
Bool | readOnly | Target field is read only in GUi. |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
Bool readOnly;
thing.SetReadOnly(readOnly);
SetRecordId(Integer)
A refcount entity for a number allocation.
Declaration
Void SetRecordId(Integer recordId)
Parameters
Type | Name | Description |
---|---|---|
Integer | recordId | Record ID in target table, used when there are separate counters for each target record. |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
Integer recordId;
thing.SetRecordId(recordId);
SetRefCountsId(Integer)
A refcount entity for a number allocation.
Declaration
Void SetRefCountsId(Integer refCountsId)
Parameters
Type | Name | Description |
---|---|---|
Integer | refCountsId | Primary key. |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
Integer refCountsId;
thing.SetRefCountsId(refCountsId);
SetSatPrefix(Integer)
A refcount entity for a number allocation.
Declaration
Void SetSatPrefix(Integer satPrefix)
Parameters
Type | Name | Description |
---|---|---|
Integer | satPrefix | size of prefix for Satellite use of this counter. |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
Integer satPrefix;
thing.SetSatPrefix(satPrefix);
SetSuggestedRecords(NSMDOListItem[])
A refcount entity for a number allocation.
Declaration
Void SetSuggestedRecords(NSMDOListItem[] suggestedRecords)
Parameters
Type | Name | Description |
---|---|---|
NSMDOListItem[] | suggestedRecords | List of valid entities, the associated record is selected in the list, used records are filtered out. |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
NSMDOListItem[] suggestedRecords;
thing.SetSuggestedRecords(suggestedRecords);
SetTravelPrefix(Integer)
A refcount entity for a number allocation.
Declaration
Void SetTravelPrefix(Integer travelPrefix)
Parameters
Type | Name | Description |
---|---|---|
Integer | travelPrefix | size of prefix for Travel use of ths counter. |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
Integer travelPrefix;
thing.SetTravelPrefix(travelPrefix);
SetUnique(Bool)
Checks that entered value is unique
Declaration
Void SetUnique(Bool unique)
Parameters
Type | Name | Description |
---|---|---|
Bool | unique |
Returns
Type | Description |
---|---|
Void |
Examples
NSRefCountEntity thing;
Bool unique;
thing.SetUnique(unique);