ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/service/WidgetParameterService.java

   1 /*-\r
   2  * ================================================================================\r
   3  * ECOMP Portal\r
   4  * ================================================================================\r
   5  * Copyright (C) 2017 AT&T Intellectual Property\r
   6  * ================================================================================\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  * \r
  11  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * \r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  * ================================================================================\r
  19  */\r
  20 package org.openecomp.portalapp.portal.service;\r
  21 \r
  22 import java.util.List;\r
  23 \r
  24 import org.openecomp.portalapp.portal.domain.WidgetCatalogParameter;\r
  25 \r
  26 public interface WidgetParameterService {\r
  27         \r
  28         /**\r
  29          * Saves the specified user-defined widget parameters to the table ep_widget_parameters\r
  30          * \r
  31          * @param newParameter\r
  32          */\r
  33         void saveUserParameter(WidgetCatalogParameter newParameter);\r
  34         \r
  35         /**\r
  36          * Gets the specified user-defined widget parameter where paramId is used from all users \r
  37          * \r
  38          * @param paramId\r
  39          * @return\r
  40          * List of widget parameters\r
  41          */\r
  42         List<WidgetCatalogParameter> getUserParameterById(Long paramId);\r
  43         \r
  44         \r
  45         /**\r
  46          * Deletes the specified user-defined widget parameters from ep_widget_parameters table \r
  47          * where paramId is used\r
  48          * \r
  49          * @param paramId\r
  50          */\r
  51         void deleteUserParameterById(Long paramId);\r
  52 \r
  53         \r
  54         /**\r
  55          * Gets the specified user-defined widget parameter where paramId is used from the specified\r
  56          * user with userId \r
  57          * @param widgetId\r
  58          * @param userId\r
  59          * @param paramId\r
  60          * @return\r
  61          */\r
  62         WidgetCatalogParameter getUserParamById(Long widgetId, Long userId, Long paramId);\r
  63         \r
  64 }\r