Class NSHeadingEntity

The heading entity contains generic list item information.

Constructors

NSHeadingEntity()

Initializes a new instance of the NSHeadingEntity class.

Declaration

NSHeadingEntity

Methods

GetDeleted()

Declaration

Bool GetDeleted()

Examples

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

Returns

Type Description
Bool True if the heading is marked as deleted.

GetHeadingId()

Declaration

Integer GetHeadingId()

Examples

NSHeadingEntity thing;
Integer headingId = thing.GetHeadingId();

Returns

Type Description
Integer Primary key.

GetName()

Declaration

String GetName()

Examples

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

Returns

Type Description
String The visible heading.

GetRank()

Declaration

Integer GetRank()

Examples

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

Returns

Type Description
Integer Rank order.

GetTooltip()

Declaration

String GetTooltip()

Examples

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

Returns

Type Description
String Tooltip or other description.

GetUdListDefinitionId()

Declaration

Integer GetUdListDefinitionId()

Examples

NSHeadingEntity thing;
Integer udListDefinitionId = thing.GetUdListDefinitionId();

Returns

Type Description
Integer The ID of the list which this heading belongs to.

SetDeleted(Bool)

Declaration

Void SetDeleted(Bool deleted)

Examples

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

Parameters

Type Name Description
Bool deleted True if the heading is marked as deleted.

Returns

Type Description
Void

SetHeadingId(Integer)

Declaration

Void SetHeadingId(Integer headingId)

Examples

NSHeadingEntity thing;
Integer headingId;
thing.SetHeadingId(headingId);

Parameters

Type Name Description
Integer headingId Primary key.

Returns

Type Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

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

Parameters

Type Name Description
String name The visible heading.

Returns

Type Description
Void

SetRank(Integer)

Declaration

Void SetRank(Integer rank)

Examples

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

Parameters

Type Name Description
Integer rank Rank order.

Returns

Type Description
Void

SetTooltip(String)

Declaration

Void SetTooltip(String tooltip)

Examples

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

Parameters

Type Name Description
String tooltip Tooltip or other description.

Returns

Type Description
Void

SetUdListDefinitionId(Integer)

Declaration

Void SetUdListDefinitionId(Integer udListDefinitionId)

Examples

NSHeadingEntity thing;
Integer udListDefinitionId;
thing.SetUdListDefinitionId(udListDefinitionId);

Parameters

Type Name Description
Integer udListDefinitionId The ID of the list which this heading belongs to.

Returns

Type Description
Void