summaryrefslogtreecommitdiffstats
path: root/cps-service/src/main/java/org/onap/cps/spi/DataPersistenceService.java
blob: a3cbc28c55a84e8cbf07f641d8d353776b87bbd3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/*
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2020 Nordix Foundation
 *  ================================================================================
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  SPDX-License-Identifier: Apache-2.0
 *  ============LICENSE_END=========================================================
 */

package org.onap.cps.spi;

/**
 * Defines methods to access and manipulate data using the chosen database solution.
 */
public interface DataPersistenceService {

    /**
     * Store the JSON structure in the database.
     *
     * @param jsonStructure the JSON structure.
     * @return jsonEntityID the ID of the JSON entity.
     */
    Integer storeJsonStructure(final String jsonStructure);

    /**
     * Get the JSON structure from the database using the entity identifier.
     *
     * @param jsonStructureId the json entity identifier.
     * @return a JSON Structure.
     */
    String getJsonById(int jsonStructureId);

    /**
     * Delete the JSON structure from the database using the entity identifier.
     *
     * @param jsonStructureId the json entity identifier.
     */
    void deleteJsonById(int jsonStructureId);
}