summaryrefslogtreecommitdiffstats
path: root/zusammen-lib/src/main/java/org/onap/sdc/common/zusammen/persistence/ZusammenConnector.java
blob: 98640e2c52eda3a10289aeb2855efa2da89bd7d5 (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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*
 * Copyright © 2016-2018 European Support Limited
 *
 * 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.
 */

package org.onap.sdc.common.zusammen.persistence;

import com.amdocs.zusammen.adaptor.inbound.api.types.item.Element;
import com.amdocs.zusammen.adaptor.inbound.api.types.item.ElementConflict;
import com.amdocs.zusammen.adaptor.inbound.api.types.item.ElementInfo;
import com.amdocs.zusammen.adaptor.inbound.api.types.item.ItemVersionConflict;
import com.amdocs.zusammen.commons.health.data.HealthInfo;
import com.amdocs.zusammen.datatypes.Id;
import com.amdocs.zusammen.datatypes.SessionContext;
import com.amdocs.zusammen.datatypes.item.ElementContext;
import com.amdocs.zusammen.datatypes.item.Info;
import com.amdocs.zusammen.datatypes.item.Item;
import com.amdocs.zusammen.datatypes.item.ItemVersion;
import com.amdocs.zusammen.datatypes.item.ItemVersionData;
import com.amdocs.zusammen.datatypes.item.ItemVersionStatus;
import com.amdocs.zusammen.datatypes.item.Resolution;
import com.amdocs.zusammen.datatypes.itemversion.ItemVersionRevisions;
import com.amdocs.zusammen.datatypes.itemversion.Tag;
import java.util.Collection;

public interface ZusammenConnector {

  Collection<HealthInfo> checkHealth(SessionContext sessionContext);

  String getReleaseVersion(SessionContext sessionContext);

  Collection<Item> listItems(SessionContext context);

  Item getItem(SessionContext context, Id itemId);

  Id createItem(SessionContext context, Info info);

  void deleteItem(SessionContext context, Id itemId);

  void updateItem(SessionContext context, Id itemId, Info info);


  Collection<ItemVersion> listPublicVersions(SessionContext context, Id itemId);

  ItemVersion getPublicVersion(SessionContext context, Id itemId, Id versionId);

  Id createVersion(SessionContext context, Id itemId, Id baseVersionId, ItemVersionData itemVersionData);

  void updateVersion(SessionContext context, Id itemId, Id versionId, ItemVersionData itemVersionData);

  ItemVersion getVersion(SessionContext context, Id itemId, Id versionId);

  ItemVersionStatus getVersionStatus(SessionContext context, Id itemId, Id versionId);

  void tagVersion(SessionContext context, Id itemId, Id versionId, Tag tag);

  void resetVersionRevision(SessionContext context, Id itemId, Id versionId, Id revisionId);

  void revertVersionRevision(SessionContext context, Id itemId, Id versionId, Id revisionId);

  ItemVersionRevisions listVersionRevisions(SessionContext context, Id itemId, Id versionId);

  void publishVersion(SessionContext context, Id itemId, Id versionId, String message);

  void syncVersion(SessionContext context, Id itemId, Id versionId);

  void forceSyncVersion(SessionContext context, Id itemId, Id versionId);

  void cleanVersion(SessionContext context, Id itemId, Id versionId);

  ItemVersionConflict getVersionConflict(SessionContext context, Id itemId, Id versionId);


  Collection<ElementInfo> listElements(SessionContext context, ElementContext elementContext, Id parentElementId);

  ElementInfo getElementInfo(SessionContext context, ElementContext elementContext, Id elementId);

  Element getElement(SessionContext context, ElementContext elementContext, Id elementId);

  ElementConflict getElementConflict(SessionContext context, ElementContext elementContext, Id elementId);

  Element saveElement(SessionContext context, ElementContext elementContext, Element element, String message);

  void resolveElementConflict(SessionContext context, ElementContext elementContext, Element element,
          Resolution resolution);

}