Show / Hide Table of Contents

Class NSRelationDefinitionEntity

A relation definition entity with source and destination tables.

Syntax

Constructors

NSRelationDefinitionEntity()

Initializes a new instance of the NSRelationDefinitionEntity class.

Declaration
NSRelationDefinitionEntity

Methods

GetDeleted()

A relation definition entity with source and destination tables.

Declaration
Bool GetDeleted()
Returns
Type Description
Bool

True if deleted.

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

GetDestination()

A relation definition entity with source and destination tables.

Declaration
Integer GetDestination()
Returns
Type Description
Integer

The destination of the relation. See RelationTarget.

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

GetName()

A relation definition entity with source and destination tables.

Declaration
String GetName()
Returns
Type Description
String

Active text.

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

GetPassiveText()

A relation definition entity with source and destination tables.

Declaration
String GetPassiveText()
Returns
Type Description
String

Text used in passive direction.

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

GetRank()

A relation definition entity with source and destination tables.

Declaration
Integer GetRank()
Returns
Type Description
Integer

Rank order.

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

GetReldefId()

A relation definition entity with source and destination tables.

Declaration
Integer GetReldefId()
Returns
Type Description
Integer

primary key.

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

GetSource()

A relation definition entity with source and destination tables.

Declaration
Integer GetSource()
Returns
Type Description
Integer

The source of the relation. See RelationTarget.

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

GetTooltip()

A relation definition entity with source and destination tables.

Declaration
String GetTooltip()
Returns
Type Description
String

Tooltip or other description.

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

SetDeleted(Bool)

A relation definition entity with source and destination tables.

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)

A relation definition entity with source and destination tables.

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)

A relation definition entity with source and destination tables.

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)

A relation definition entity with source and destination tables.

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)

A relation definition entity with source and destination tables.

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)

A relation definition entity with source and destination tables.

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)

A relation definition entity with source and destination tables.

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)

A relation definition entity with source and destination tables.

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);
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top