cps-service/src/main/java/org/onap/cps/api/CpService.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation
   4  *  Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  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.api;
  22
  23 /**
  24  * Configuration and persistency service interface which holds methods for parsing and storing yang models and data.
  25  */
  26 public interface CpService {
  27
  28     /**
  29      * Store the JSON structure in the database.
  30      *
  31      * @param jsonStructure the JSON structure.
  32      * @return entity ID.
  33      */
  34     Integer storeJsonStructure(String jsonStructure);
  35
  36     /**
  37      * Read a JSON Object using the object identifier.
  38      *
  39      * @param jsonObjectId the JSON object identifier.
  40      * @return the JSON structure.
  41      */
  42     String getJsonById(int jsonObjectId);
  43
  44     /**
  45      * Delete a JSON Object using the object identifier.
  46      *
  47      * @param jsonObjectId the JSON object identifier.
  48      */
  49     void deleteJsonById(int jsonObjectId);
  50
  51 }