Class NSRelationDefinitionEntity

A relation definition entity with source and destination tables.

Syntax

Constructors

NSRelationDefinitionEntity()

Initializes a new instance of the NSRelationDefinitionEntity class.

Introduced or updated in version: 7.5

Declaration

NSRelationDefinitionEntity

Methods

GetDeleted()

Introduced or updated in version: 7.5

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	True if deleted.

Examples

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

GetDestination()

Introduced or updated in version: 7.5

Declaration

Integer GetDestination()

Returns

Type	Description
Integer	The destination of the relation. See RelationTarget.

Examples

NSRelationDefinitionEntity thing;
Integer destination = thing.GetDestination();

GetName()

Introduced or updated in version: 7.5

Declaration

String GetName()

Returns

Type	Description
String	Active text.

Examples

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

GetPassiveText()

Introduced or updated in version: 7.5

Declaration

String GetPassiveText()

Returns

Type	Description
String	Text used in passive direction.

Examples

NSRelationDefinitionEntity thing;
String passiveText = thing.GetPassiveText();

GetRank()

Introduced or updated in version: 7.5

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank order.

Examples

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

GetReldefId()

Introduced or updated in version: 7.5

Declaration

Integer GetReldefId()

Returns

Type	Description
Integer	primary key.

Examples

NSRelationDefinitionEntity thing;
Integer reldefId = thing.GetReldefId();

GetSource()

Introduced or updated in version: 7.5

Declaration

Integer GetSource()

Returns

Type	Description
Integer	The source of the relation. See RelationTarget.

Examples

NSRelationDefinitionEntity thing;
Integer source = thing.GetSource();

GetTooltip()

Introduced or updated in version: 7.5

Declaration

String GetTooltip()

Returns

Type	Description
String	Tooltip or other description.

Examples

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

SetDeleted(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	True if deleted.

Returns

Type	Description
Void

Examples

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

SetDestination(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetDestination(Integer destination)

Parameters

Type	Name	Description
Integer	destination	The destination of the relation. See RelationTarget.

Returns

Type	Description
Void

Examples

NSRelationDefinitionEntity thing;
Integer destination;
thing.SetDestination(destination);

SetName(String)

Introduced or updated in version: 7.5

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	Active text.

Returns

Type	Description
Void

Examples

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

SetPassiveText(String)

Introduced or updated in version: 7.5

Declaration

Void SetPassiveText(String passiveText)

Parameters

Type	Name	Description
String	passiveText	Text used in passive direction.

Returns

Type	Description
Void

Examples

NSRelationDefinitionEntity thing;
String passiveText;
thing.SetPassiveText(passiveText);

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

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

SetReldefId(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetReldefId(Integer reldefId)

Parameters

Type	Name	Description
Integer	reldefId	Primary key.

Returns

Type	Description
Void

Examples

NSRelationDefinitionEntity thing;
Integer reldefId;
thing.SetReldefId(reldefId);

SetSource(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetSource(Integer source)

Parameters

Type	Name	Description
Integer	source	The source of the relation. See RelationTarget.

Returns

Type	Description
Void

Examples

NSRelationDefinitionEntity thing;
Integer source;
thing.SetSource(source);

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

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