From 0741df92ef89c8217cc8f53e16dbbecc180074c5 Mon Sep 17 00:00:00 2001
From: Johannes Hoermann <j.hoermann@adito.de>
Date: Tue, 25 Jun 2019 15:52:25 +0200
Subject: [PATCH] Comments

---
 process/Ticket_lib/process.js | 56 +++++++++++++++++++++++++++++++----
 1 file changed, 51 insertions(+), 5 deletions(-)

diff --git a/process/Ticket_lib/process.js b/process/Ticket_lib/process.js
index 0a3c0e3f52..f5bb788424 100644
--- a/process/Ticket_lib/process.js
+++ b/process/Ticket_lib/process.js
@@ -13,6 +13,10 @@ import("Sql_lib");
  * Tickets are in an extra Table 'TICKET' and the task table is joined to it. All tasks with type Ticket should be also in 'TICKET'.
  * --> if you need all information for a Ticket, just select from TICKET left join TASK on TASK_ID = TASKID
  * 
+ * Note that all methods which do not need the ticket type are static.
+ * 
+ * @param {String} pTicketType the Keyid of Keyword TicketType
+ * 
  * @class
  */
 function TicketUtils(pTicketType) 
@@ -20,11 +24,22 @@ function TicketUtils(pTicketType)
     this.type = pTicketType;
 }
 
+/**
+ * create new instance. You can also use normal constructor. This is just for convenience.
+ * TicketUtils.begin(vars.get("$field.TICKETTYPE"))
+ *            ...
+ * @param {String} pTicketType the Keyid of Keyword TicketType
+ * @return {TicketUtils}
+ */
 TicketUtils.begin = function(pTicketType)
 {
     return new TicketUtils(pTicketType);
 }
    
+/**
+ * get the icon for the status. (from Keyword attributes)
+ * @return {String} pStatus
+ */
 TicketUtils.getStatusIcon = function(pStatus)
 {
     return TaskUtils.getStatusIcon(pStatus);
@@ -39,8 +54,8 @@ TicketUtils.getStatusIcon = function(pStatus)
  */
 TicketUtils.addLinkRecords= function(pObjectIdField, pRowIdField, pAdditionalLinksField, pParentContextField, pParentIdField)
 {
-    throw Error("Not fully implemented yet");
-    TaskUtils.addLinkRecords(pObjectIdField, pRowIdField, pAdditionalLinksField, pParentContextField, pParentIdField, "Links");
+    throw Error("Not implemented yet");
+    //TaskUtils.addLinkRecords(pObjectIdField, pRowIdField, pAdditionalLinksField, pParentContextField, pParentIdField, "Links");
 }
    
 /**
@@ -52,7 +67,11 @@ TicketUtils.prototype.createNewTicket = function(pRowId, pAdditionalLinks, pPare
 }
 
 /**
- * check if an object has tickets
+ * check if an object has tickets (of current ticket type)
+ * @param {String} pRowId
+ * @param {String} pObjectType
+ * 
+ * @return {Boolean} true, if object is linked with at least one ticket of the given TicketType
  */
 TicketUtils.prototype.hasTickets = function(pRowId, pObjectType)
 {
@@ -71,17 +90,32 @@ TicketUtils.prototype.hasTickets = function(pRowId, pObjectType)
         return true;
 }
 
+/**
+ * Check if the given TicketType has attributes. (stored as keyword attribute as json array containing AtributeIds)
+ * 
+ * @return {Boolean} true if the type has attributes
+ */
 TicketUtils.prototype.typeHasAttributes = function()
 {
     return this.getTypeAttributes().length > 0;
 }
 
+/**
+ * Get all possible attributes for the given TicketType. (stored as keyword attribute as json array containing AtributeIds)
+ * 
+ * @return {String[]} all possible attributes (or attribute groups) of a TicketType
+ */
 TicketUtils.prototype.getTypeAttributes = function()
 {
-    logging.log(this.type +" a " + JSON.parse(KeywordUtils.getAttributeRelation(this.type, $KeywordRegistry.ticketType(), "attributes", "[]")).toSource())
     return JSON.parse(KeywordUtils.getAttributeRelation(this.type, $KeywordRegistry.ticketType(), "attributes", "[]"));
 }
 
+/**
+ * Get list of all available Status.
+ * Alle Tasks and Tickets use the same Status Keyword. This enables to use a group by / search over the full Task-table
+ * 
+ * @return {String[]|null} all status keyids stored as keywordattribute of the TicketType keyword. Or null if the keywordattribute doesn't exist
+ */
 TicketUtils.prototype.getAvailableStatus = function()
 {
     states = JSON.parse(KeywordUtils.getAttributeRelation(this.type, $KeywordRegistry.ticketType(), "availableStatus", ""))
@@ -91,11 +125,21 @@ TicketUtils.prototype.getAvailableStatus = function()
     return states.map(TicketUtils._toChar36);
 }
 
+/**
+ * Get the default status stored as keywordattribute of the TicketType keyword.
+ * 
+ * @return {String} the Keyid of the default status
+ */
 TicketUtils.prototype.getDefaultStatus = function()
 {
     return TicketUtils._toChar36(KeywordUtils.getAttributeRelation(this.type, $KeywordRegistry.ticketType(), "defaultStatus", ""));
 }
 
+/**
+ * Get the default priority for the tickettype.
+ * 
+ * @return {String} the keyid of the default priority
+ */
 TicketUtils.prototype.getDefaultPriority = function()
 {
     // Imporant: if you would like to change priority/ add or remove possible priorities 
@@ -104,8 +148,10 @@ TicketUtils.prototype.getDefaultPriority = function()
     return $KeywordRegistry.taskPriority$low();
 }
 
+/**
+ * converts a string to a string of always 36 chars. Whitespaces are added at the end if needed.
+ */
 TicketUtils._toChar36 = function(pValue) 
 {
-    logging.log(pValue)
     return (pValue + "                                    ").slice(0, 36);
 }
\ No newline at end of file
-- 
GitLab