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

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