Class NSKbCategory

Constructors

NSKbCategory()

Initializes a new instance of the NSKbCategory class.

Declaration

NSKbCategory

Methods

GetDescription()

Declaration

String GetDescription()

Examples

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

Returns

Type Description
String The description of this category.

GetFullname()

Declaration

String GetFullname()

Examples

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

Returns

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

GetKbCategoryId()

Declaration

Integer GetKbCategoryId()

Examples

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

Returns

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

GetName()

Declaration

String GetName()

Examples

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

Returns

Type Description
String The name of this category.

GetParentId()

Declaration

Integer GetParentId()

Examples

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

Returns

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

GetSortOrder()

Declaration

Integer GetSortOrder()

Examples

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

Returns

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

SetDescription(String)

Declaration

Void SetDescription(String description)

Examples

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

Parameters

Type Name Description
String description The description of this category.

Returns

Type Description
Void

SetFullname(String)

Declaration

Void SetFullname(String fullname)

Examples

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

Parameters

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

Returns

Type Description
Void

SetKbCategoryId(Integer)

Declaration

Void SetKbCategoryId(Integer kbCategoryId)

Examples

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

Parameters

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

Returns

Type Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

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

Parameters

Type Name Description
String name The name of this category.

Returns

Type Description
Void

SetParentId(Integer)

Declaration

Void SetParentId(Integer parentId)

Examples

NSKbCategory thing;
Integer parentId;
thing.SetParentId(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

SetSortOrder(Integer)

Declaration

Void SetSortOrder(Integer sortOrder)

Examples

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

Parameters

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

Returns

Type Description
Void