Class NSKbCategory

Syntax

Constructors

NSKbCategory()

Initializes a new instance of the NSKbCategory class.

Declaration

NSKbCategory

Methods

GetDescription()

Declaration

String GetDescription()

Returns

Type	Description
String	The description of this category.

Examples

NSKbCategory thing;
String description = thing.GetDescription();

GetFullname()

Declaration

String GetFullname()

Returns

Type	Description
String	The full name of this category, i.e. Foo/bar/test.

Examples

NSKbCategory thing;
String fullname = thing.GetFullname();

GetKbCategoryId()

Declaration

Integer GetKbCategoryId()

Returns

Type	Description
Integer	The primary key (auto-incremented).

Examples

NSKbCategory thing;
Integer kbCategoryId = thing.GetKbCategoryId();

GetName()

Declaration

String GetName()

Returns

Type	Description
String	The name of this category.

Examples

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

GetParentId()

Declaration

Integer GetParentId()

Returns

Type	Description
Integer	This entry contains a reference to the parent category. NULL or -1 if this is a top-level category.

Examples

NSKbCategory thing;
Integer parentId = thing.GetParentId();

GetSortOrder()

Declaration

Integer GetSortOrder()

Returns

Type	Description
Integer	A strictly ascending number used for sorting categories when they are listed.

Examples

NSKbCategory thing;
Integer sortOrder = thing.GetSortOrder();

SetDescription(String)

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	The description of this category.

Returns

Type	Description
Void

Examples

NSKbCategory thing;
String description;
thing.SetDescription(description);

SetFullname(String)

Declaration

Void SetFullname(String fullname)

Parameters

Type	Name	Description
String	fullname	The full name of this category, i.e. Foo/bar/test.

Returns

Type	Description
Void

Examples

NSKbCategory thing;
String fullname;
thing.SetFullname(fullname);

SetKbCategoryId(Integer)

Declaration

Void SetKbCategoryId(Integer kbCategoryId)

Parameters

Type	Name	Description
Integer	kbCategoryId	The primary key (auto-incremented).

Returns

Type	Description
Void

Examples

NSKbCategory thing;
Integer kbCategoryId;
thing.SetKbCategoryId(kbCategoryId);

SetName(String)

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The name of this category.

Returns

Type	Description
Void

Examples

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

SetParentId(Integer)

Declaration

Void SetParentId(Integer parentId)

Parameters

Type	Name	Description
Integer	parentId	This entry contains a reference to the parent category. NULL or -1 if this is a top-level category.

Returns

Type	Description
Void

Examples

NSKbCategory thing;
Integer parentId;
thing.SetParentId(parentId);

SetSortOrder(Integer)

Declaration

Void SetSortOrder(Integer sortOrder)

Parameters

Type	Name	Description
Integer	sortOrder	A strictly ascending number used for sorting categories when they are listed.

Returns

Type	Description
Void

Examples

NSKbCategory thing;
Integer sortOrder;
thing.SetSortOrder(sortOrder);