cps-ri/src/main/java/org/onap/cps/spi/repository/FragmentNativeRepository.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023 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.cps.spi.repository;
  22
  23 import java.util.Collection;
  24
  25 /**
  26  * This interface is used in delete fragment entity by id with child using native sql queries.
  27  */
  28 public interface FragmentNativeRepository {
  29     void deleteFragmentEntity(long fragmentEntityId);
  30
  31     /**
  32      * Delete fragment entities for each supplied xpath.
  33      * This method will delete list elements or other data nodes, but not whole lists.
  34      * Non-existing xpaths will not result in an exception.
  35      * @param anchorId the id of the anchor
  36      * @param xpaths   xpaths of data nodes to remove
  37      */
  38     void deleteByAnchorIdAndXpaths(int anchorId, Collection<String> xpaths);
  39
  40     /**
  41      * Delete fragment entities that are list elements of each supplied list xpath.
  42      * For example, if xpath '/parent/list' is provided, then list all elements in '/parent/list' will be deleted,
  43      * e.g. /parent/list[@key='A'], /parent/list[@key='B'].
  44      * This method will only delete whole lists by xpath; xpaths to list elements or other data nodes will be ignored.
  45      * Non-existing xpaths will not result in an exception.
  46      * @param anchorId   the id of the anchor
  47      * @param listXpaths xpaths of whole lists to remove
  48      */
  49     void deleteListsByAnchorIdAndXpaths(int anchorId, Collection<String> listXpaths);
  50 }