Class NSTicketCategoryEntity

Describes the meta data for a ticket category, and provides special operations on it.

Syntax

Constructors

NSTicketCategoryEntity()

Initializes a new instance of the NSTicketCategoryEntity class.

Declaration

NSTicketCategoryEntity

Methods

GetAssignmentLag()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Integer GetAssignmentLag()

Returns

Type	Description
Integer	Number of minutes we shall override the assignment if a customer sends consecutive messages to this category.

Examples

NSTicketCategoryEntity thing;
Integer assignmentLag = thing.GetAssignmentLag();

GetCategoryMaster()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Integer GetCategoryMaster()

Returns

Type	Description
Integer	The user associated with this category.

Examples

NSTicketCategoryEntity thing;
Integer categoryMaster = thing.GetCategoryMaster();

GetClosingStatus()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Integer GetClosingStatus()

Returns

Type	Description
Integer	Should new requests have the 'close request' in this category checked as default, or should the users preferences be selected? See TicketCategoryClosingStatus

Examples

NSTicketCategoryEntity thing;
Integer closingStatus = thing.GetClosingStatus();

GetCustomFields()

Gets the user-defined + extra fields on an NSTicketCategoryEntity as a map.

Declaration

Map GetCustomFields()

Returns

Type	Description
Map

Examples

NSTicketCategoryEntity thing;
Map fields = thing.GetCustomFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

GetDelegateMethod()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Integer GetDelegateMethod()

Returns

Type	Description
Integer	An integer indicating the delegation method for this category. See TicketCategoryDelegateMethod.

Examples

NSTicketCategoryEntity thing;
Integer delegateMethod = thing.GetDelegateMethod();

GetExternalName()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

String GetExternalName()

Returns

Type	Description
String	The external name for this category, used for the customer frontend.

Examples

NSTicketCategoryEntity thing;
String externalName = thing.GetExternalName();

GetExtraFields()

Gets the extra fields on NSTicketCategoryEntity as a map.

Declaration

Map GetExtraFields()

Returns

Type	Description
Map	Map containing extra field values by field name.

Examples

NSTicketCategoryEntity thing;
Map fields = thing.GetExtraFields();
String oldValue = fields.get("x_foobar");
fields.insert("x_foobar", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

GetFlags()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Integer GetFlags()

Returns

Type	Description
Integer	A bitmask representing flags for this category. See TicketCategoryFlags.

Examples

NSTicketCategoryEntity thing;
Integer flags = thing.GetFlags();

GetFullname()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

String GetFullname()

Returns

Type	Description
String	The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'.

Examples

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

GetMsgClosingStatus()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Integer GetMsgClosingStatus()

Returns

Type	Description
Integer	Should new messages have the 'close request' in this category checked as default, or should the users preferences be selected? See TicketCategoryClosingStatus.

Examples

NSTicketCategoryEntity thing;
Integer msgClosingStatus = thing.GetMsgClosingStatus();

GetName()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

String GetName()

Returns

Type	Description
String	The (short) name of this category. E.g. 'support'.

Examples

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

GetNotificationEmail()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

String GetNotificationEmail()

Returns

Type	Description
String	Comma-separated list of addresses to notify when requests are re-delegated to (unassigned) in this category.

Examples

NSTicketCategoryEntity thing;
String notificationEmail = thing.GetNotificationEmail();

GetParentId()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Integer GetParentId()

Returns

Type	Description
Integer	The parent category for this category. -1 if this is a top-level category.

Examples

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

GetReplyTemplate()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Integer GetReplyTemplate()

Returns

Type	Description
Integer	Reply template to merge with messages posted in this category.

Examples

NSTicketCategoryEntity thing;
Integer replyTemplate = thing.GetReplyTemplate();

GetTicketCategoryId()

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Integer GetTicketCategoryId()

Returns

Type	Description
Integer	The ID of the ticket category. (primary key).

Examples

NSTicketCategoryEntity thing;
Integer ticketCategoryId = thing.GetTicketCategoryId();

SetAssignmentLag(Integer)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetAssignmentLag(Integer assignmentLag)

Parameters

Type	Name	Description
Integer	assignmentLag	Number of minutes we shall override the assignment if a customer sends consecutive messages to this category.

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
Integer assignmentLag;
thing.SetAssignmentLag(assignmentLag);

SetCategoryMaster(Integer)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetCategoryMaster(Integer categoryMaster)

Parameters

Type	Name	Description
Integer	categoryMaster	The user associated with this category.

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
Integer categoryMaster;
thing.SetCategoryMaster(categoryMaster);

SetClosingStatus(Integer)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetClosingStatus(Integer closingStatus)

Parameters

Type	Name	Description
Integer	closingStatus	Should new requests have the 'close request' in this category checked as default, or should the users preferences be selected. See TicketCategoryClosingStatus.

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
Integer closingStatus;
thing.SetClosingStatus(closingStatus);

SetCustomFields(Map)

Sets the user-defined and extra fields on an NSTicketCategoryEntity with a map.

Declaration

Void SetCustomFields(Map udefs)

Parameters

Type	Name	Description
Map	udefs

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
udefs["x_foo"] = "foobar";
udefs["x_bar"] = "456"; // List item id
thing.SetCustomFields(udefs);

SetDelegateMethod(Integer)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetDelegateMethod(Integer delegateMethod)

Parameters

Type	Name	Description
Integer	delegateMethod	An integer indicating the delegation method for this category. See TicketCategoryDelegateMethod.

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
Integer delegateMethod;
thing.SetDelegateMethod(delegateMethod);

SetExternalName(String)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetExternalName(String externalName)

Parameters

Type	Name	Description
String	externalName	The external name for this category, used for the customer frontend.

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
String externalName;
thing.SetExternalName(externalName);

SetExtraFields(Map)

Sets the extra field values on NSTicketCategoryEntity with a map.

Declaration

Void SetExtraFields(Map extras)

Parameters

Type	Name	Description
Map	extras

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
Map extras;
extras["SuperOffice:1"] = "[I:123]";
extras["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
extras["custom.progid"] = "foobar";
thing.SetExtraFields(extras);

SetFlags(Integer)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetFlags(Integer flags)

Parameters

Type	Name	Description
Integer	flags	A bitmask representing flags for this category. See TicketCategoryFlags.

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
Integer flags;
thing.SetFlags(flags);

SetFullname(String)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetFullname(String fullname)

Parameters

Type	Name	Description
String	fullname	The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'.

Returns

Type	Description
Void

Examples

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

SetMsgClosingStatus(Integer)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetMsgClosingStatus(Integer msgClosingStatus)

Parameters

Type	Name	Description
Integer	msgClosingStatus	Should new messages have the 'close request' in this category checked as default, or should the users preferences be selected? See TicketCategoryClosingStatus.

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
Integer msgClosingStatus;
thing.SetMsgClosingStatus(msgClosingStatus);

SetName(String)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The (short) name of this category. E.g. 'support'.

Returns

Type	Description
Void

Examples

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

SetNotificationEmail(String)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetNotificationEmail(String notificationEmail)

Parameters

Type	Name	Description
String	notificationEmail	Comma-separated list of addresses to notify when requests are re-delegated to (unassigned) in this category.

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
String notificationEmail;
thing.SetNotificationEmail(notificationEmail);

SetParentId(Integer)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetParentId(Integer parentId)

Parameters

Type	Name	Description
Integer	parentId	The parent category for this category. -1 if this is a top-level category.

Returns

Type	Description
Void

Examples

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

SetReplyTemplate(Integer)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetReplyTemplate(Integer replyTemplate)

Parameters

Type	Name	Description
Integer	replyTemplate	Reply template to merge with messages posted in this category.

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
Integer replyTemplate;
thing.SetReplyTemplate(replyTemplate);

SetTicketCategoryId(Integer)

Describes the meta data for a ticket category, and provides special operations on it.

Declaration

Void SetTicketCategoryId(Integer ticketCategoryId)

Parameters

Type	Name	Description
Integer	ticketCategoryId	The ID of the ticket category. (primary key).

Returns

Type	Description
Void

Examples

NSTicketCategoryEntity thing;
Integer ticketCategoryId;
thing.SetTicketCategoryId(ticketCategoryId);