models-pdp/src/main/java/org/onap/policy/models/pdp/persistence/provider/PdpProvider.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.models.pdp.persistence.provider;
  22
  23 import lombok.NonNull;
  24
  25 import org.onap.policy.models.base.PfModelException;
  26 import org.onap.policy.models.dao.PfDao;
  27 import org.onap.policy.models.pdp.concepts.PdpGroups;
  28
  29 /**
  30  * This class provides the provision of information on PAP concepts in the database to callers.
  31  *
  32  * @author Liam Fallon (liam.fallon@est.tech)
  33  */
  34 public class PdpProvider {
  35     /**
  36      * Get PDP groups.
  37      *
  38      * @param dao the DAO to use to access the database
  39      * @param pdpGroupFilter a filter for the get
  40      * @return the PDP groups found
  41      * @throws PfModelException on errors getting PDP groups
  42      */
  43     public PdpGroups getPdpGroups(@NonNull final PfDao dao, @NonNull final String pdpGroupFilter)
  44             throws PfModelException {
  45         return new PdpGroups();
  46     }
  47
  48     /**
  49      * Creates PDP groups.
  50      *
  51      * @param dao the DAO to use to access the database
  52      * @param pdpGroups a specification of the PDP groups to create
  53      * @return the PDP groups created
  54      * @throws PfModelException on errors creating PDP groups
  55      */
  56     public PdpGroups createPdpGroups(@NonNull final PfDao dao, @NonNull final PdpGroups pdpGroups)
  57             throws PfModelException {
  58         return new PdpGroups();
  59     }
  60
  61     /**
  62      * Updates PDP groups.
  63      *
  64      * @param dao the DAO to use to access the database
  65      * @param pdpGroups a specification of the PDP groups to update
  66      * @return the PDP groups updated
  67      * @throws PfModelException on errors updating PDP groups
  68      */
  69     public PdpGroups updatePdpGroups(@NonNull final PfDao dao, @NonNull final PdpGroups pdpGroups)
  70             throws PfModelException {
  71         return new PdpGroups();
  72     }
  73
  74     /**
  75      * Delete PDP groups.
  76      *
  77      * @param dao the DAO to use to access the database
  78      * @param pdpGroupFilter a filter for the get
  79      * @return the PDP groups deleted
  80      * @throws PfModelException on errors deleting PDP groups
  81      */
  82     public PdpGroups deletePdpGroups(@NonNull final PfDao dao, @NonNull final String pdpGroupFilter)
  83             throws PfModelException {
  84         return new PdpGroups();
  85     }
  86 }