Class NSRefCountEntity

A refcount entity for a number allocation.

Constructors

NSRefCountEntity()

Initializes a new instance of the NSRefCountEntity class.

Declaration

NSRefCountEntity

Methods

GetAllocate()

Declaration

Bool GetAllocate()

Examples

NSRefCountEntity thing;
Bool allocate = thing.GetAllocate();

Returns

Type	Description
Bool	Allocate numbers automatically.

GetAllowBlank()

Declaration

Bool GetAllowBlank()

Examples

NSRefCountEntity thing;
Bool allowBlank = thing.GetAllowBlank();

Returns

Type	Description
Bool	Allow blank as a valid value.

GetCurrentValue()

Declaration

Integer GetCurrentValue()

Examples

NSRefCountEntity thing;
Integer currentValue = thing.GetCurrentValue();

Returns

Type	Description
Integer	Current value of counter.

GetField()

Declaration

String GetField()

Examples

NSRefCountEntity thing;
String field = thing.GetField();

Returns

Type	Description
String	Field identifier in string format table.field.

GetReadOnly()

Declaration

Bool GetReadOnly()

Examples

NSRefCountEntity thing;
Bool readOnly = thing.GetReadOnly();

Returns

Type	Description
Bool	Target field is read only in GUi.

GetRecordId()

Declaration

Integer GetRecordId()

Examples

NSRefCountEntity thing;
Integer recordId = thing.GetRecordId();

Returns

Type	Description
Integer	Record ID in target table, used when there are separate counters for each target record.

GetRefCountsId()

Declaration

Integer GetRefCountsId()

Examples

NSRefCountEntity thing;
Integer refCountsId = thing.GetRefCountsId();

Returns

Type	Description
Integer	Primary key.

GetSatPrefix()

Declaration

Integer GetSatPrefix()

Examples

NSRefCountEntity thing;
Integer satPrefix = thing.GetSatPrefix();

Returns

Type	Description
Integer	size of prefix for Satellite use of this counter.

GetSuggestedRecords()

Declaration

NSMDOListItem[] GetSuggestedRecords()

Examples

NSRefCountEntity thing;
NSMDOListItem[] suggestedRecords = thing.GetSuggestedRecords();

Returns

Type	Description
NSMDOListItem[]	List of valid entities, the associated record is selected in the list, used records are filtered out.

GetTravelPrefix()

Declaration

Integer GetTravelPrefix()

Examples

NSRefCountEntity thing;
Integer travelPrefix = thing.GetTravelPrefix();

Returns

Type	Description
Integer	size of prefix for Travel use of ths counter.

GetUnique()

Checks that entered value is unique

Declaration

Bool GetUnique()

Examples

NSRefCountEntity thing;
Bool unique = thing.GetUnique();

Returns

Type	Description
Bool

SetAllocate(Bool)

Declaration

Void SetAllocate(Bool allocate)

Examples

NSRefCountEntity thing;
Bool allocate;
thing.SetAllocate(allocate);

Parameters

Type	Name	Description
Bool	allocate	Allocate numbers automatically.

Returns

Type	Description
Void

SetAllowBlank(Bool)

Declaration

Void SetAllowBlank(Bool allowBlank)

Examples

NSRefCountEntity thing;
Bool allowBlank;
thing.SetAllowBlank(allowBlank);

Parameters

Type	Name	Description
Bool	allowBlank	Allow blank as a valid value.

Returns

Type	Description
Void

SetCurrentValue(Integer)

Declaration

Void SetCurrentValue(Integer currentValue)

Examples

NSRefCountEntity thing;
Integer currentValue;
thing.SetCurrentValue(currentValue);

Parameters

Type	Name	Description
Integer	currentValue	Current value of counter.

Returns

Type	Description
Void

SetField(String)

Declaration

Void SetField(String field)

Examples

NSRefCountEntity thing;
String field;
thing.SetField(field);

Parameters

Type	Name	Description
String	field	Field identifier in string format table.field.

Returns

Type	Description
Void

SetReadOnly(Bool)

Declaration

Void SetReadOnly(Bool readOnly)

Examples

NSRefCountEntity thing;
Bool readOnly;
thing.SetReadOnly(readOnly);

Parameters

Type	Name	Description
Bool	readOnly	Target field is read only in GUi.

Returns

Type	Description
Void

SetRecordId(Integer)

Declaration

Void SetRecordId(Integer recordId)

Examples

NSRefCountEntity thing;
Integer recordId;
thing.SetRecordId(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

SetRefCountsId(Integer)

Declaration

Void SetRefCountsId(Integer refCountsId)

Examples

NSRefCountEntity thing;
Integer refCountsId;
thing.SetRefCountsId(refCountsId);

Parameters

Type	Name	Description
Integer	refCountsId	Primary key.

Returns

Type	Description
Void

SetSatPrefix(Integer)

Declaration

Void SetSatPrefix(Integer satPrefix)

Examples

NSRefCountEntity thing;
Integer satPrefix;
thing.SetSatPrefix(satPrefix);

Parameters

Type	Name	Description
Integer	satPrefix	size of prefix for Satellite use of this counter.

Returns

Type	Description
Void

SetSuggestedRecords(NSMDOListItem[])

Declaration

Void SetSuggestedRecords(NSMDOListItem[] suggestedRecords)

Examples

NSRefCountEntity thing;
NSMDOListItem[] suggestedRecords;
thing.SetSuggestedRecords(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

SetTravelPrefix(Integer)

Declaration

Void SetTravelPrefix(Integer travelPrefix)

Examples

NSRefCountEntity thing;
Integer travelPrefix;
thing.SetTravelPrefix(travelPrefix);

Parameters

Type	Name	Description
Integer	travelPrefix	size of prefix for Travel use of ths counter.

Returns

Type	Description
Void

SetUnique(Bool)

Checks that entered value is unique

Declaration

Void SetUnique(Bool unique)

Examples

NSRefCountEntity thing;
Bool unique;
thing.SetUnique(unique);

Parameters

Type	Name	Description
Bool	unique

Returns

Type	Description
Void