From 5c356914e813b8fe4aa4fec51a4a27183466e9f3 Mon Sep 17 00:00:00 2001 From: Madawa Soysa Date: Fri, 2 Dec 2016 16:52:05 +0530 Subject: [PATCH] IOTS-296: Commenting and refactoring --- .../public/js/policy-create.js | 26 ++++++++++++++++++- .../public/js/policy-edit.js | 24 ++++++++++++++--- 2 files changed, 45 insertions(+), 5 deletions(-) diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/units/cdmf.unit.policy.create/public/js/policy-create.js b/components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/units/cdmf.unit.policy.create/public/js/policy-create.js index d52d8e7df4e..d7d7b99f149 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/units/cdmf.unit.policy.create/public/js/policy-create.js +++ b/components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/units/cdmf.unit.policy.create/public/js/policy-create.js @@ -125,6 +125,11 @@ $("#policy-name-input").focus(function(){ validateInline["policy-name"](); }); +/** + * Forward action of device type selection step. Loads relevant policy profile configurations. + * + * @param actionButton + */ stepForwardFrom["policy-platform"] = function (actionButton) { $("#device-type-policy-operations").html("").addClass("hidden"); $("#generic-policy-operations").addClass("hidden"); @@ -175,17 +180,26 @@ stepForwardFrom["policy-platform"] = function (actionButton) { }); }; +/** + * Forward action of policy profile page. Generates policy profile payload. + */ stepForwardFrom["policy-profile"] = function () { policy["profile"] = operationModule.generateProfile(policy["platform"], configuredOperations); // updating next-page wizard title with selected platform $("#policy-criteria-page-wizard-title").text("ADD " + policy["platform"] + " POLICY"); }; +/** + * Backward action of policy profile page. Moves back to platform selection step. + */ stepBackFrom["policy-profile"] = function () { // reinitialize configuredOperations configuredOperations = []; }; +/** + * Forward action of policy criteria page. + */ stepForwardFrom["policy-criteria"] = function () { $("input[type='radio'].select-users-radio").each(function () { if ($(this).is(':radio')) { @@ -223,6 +237,11 @@ var inputIsValidAgainstLength = function (input, minLength, maxLength) { return (length == minLength || (length > minLength && length < maxLength) || length == maxLength); }; +/** + * Validates policy criteria inputs. + * + * @returns {boolean} whether the validation is successful. + */ validateStep["policy-criteria"] = function () { var validationStatus = {}; var selectedAssignees; @@ -261,6 +280,11 @@ validateStep["policy-criteria"] = function () { return wizardIsToBeContinued; }; +/** + * Validating policy naming. + * + * @returns {boolean} whether the validation is successful. + */ validateStep["policy-naming"] = function () { var validationStatus = {}; @@ -390,7 +414,7 @@ var savePolicy = function (policy, isActive, serviceURL) { payload["roles"] = []; } - if(policy["selectedGroups"]) { + if(policy["selectedGroups"] && policy["selectedGroups"][0] !== "NONE") { payload["deviceGroups"] = policy["selectedGroups"]; } diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/units/cdmf.unit.policy.edit/public/js/policy-edit.js b/components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/units/cdmf.unit.policy.edit/public/js/policy-edit.js index fc69aa53e45..ce37d8d6a94 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/units/cdmf.unit.policy.edit/public/js/policy-edit.js +++ b/components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/units/cdmf.unit.policy.edit/public/js/policy-edit.js @@ -65,7 +65,7 @@ var disableInlineError = function (inputField, errorMsg, errorSign) { /** * Load all device groups. - * + * * @param callback function to call on loading completion. */ function loadGroups(callback) { @@ -79,7 +79,7 @@ function loadGroups(callback) { /** * Creates DeviceGroupWrapper object from selected groups. - * + * * @param selectedGroups * @returns {Array} DeviceGroupWrapper list. */ @@ -200,7 +200,7 @@ skipStep["policy-platform"] = function (policyPayloadObj) { script.type = 'text/javascript'; script.src = policyOperationsScriptSrc; $(".wr-advance-operations").prepend(script); - var configuredOperations = operationModule.populateProfile(policy["platform"], + var configuredOperations = operationModule.populateProfile(policy["platform"], policyPayloadObj["profile"]["profileFeaturesList"]); polulateProfileOperations(configuredOperations); } @@ -223,12 +223,18 @@ skipStep["policy-platform"] = function (policyPayloadObj) { }); }; +/** + * Forward action of policy profile page. Generates policy profile payload. + */ stepForwardFrom["policy-profile"] = function () { policy["profile"] = operationModule.generateProfile(policy["platform"], configuredOperations); // updating next-page wizard title with selected platform $("#policy-criteria-page-wizard-title").text("EDIT " + policy["platform"] + " POLICY - " + policy["name"]); }; +/** + * Forward action of policy criteria page. + */ stepForwardFrom["policy-criteria"] = function () { $("input[type='radio'].select-users-radio").each(function () { if ($(this).is(':radio')) { @@ -267,6 +273,11 @@ var inputIsValidAgainstLength = function (input, minLength, maxLength) { return (length == minLength || (length > minLength && length < maxLength) || length == maxLength); }; +/** + * Validates policy criteria inputs. + * + * @returns {boolean} whether the validation is successful. + */ validateStep["policy-criteria"] = function () { var validationStatus = {}; var selectedAssignees; @@ -305,6 +316,11 @@ validateStep["policy-criteria"] = function () { return wizardIsToBeContinued; }; +/** + * Validating policy naming. + * + * @returns {boolean} whether the validation is successful. + */ validateStep["policy-naming"] = function () { var validationStatus = {}; @@ -444,7 +460,7 @@ var updatePolicy = function (policy, state) { payload["roles"] = []; } - if (policy["selectedGroups"]) { + if (policy["selectedGroups"] && policy["selectedGroups"][0] !== "NONE") { payload["deviceGroups"] = policy["selectedGroups"]; }