Add collaboration feature
[sdc.git] / openecomp-be / lib / openecomp-core-lib / openecomp-zusammen-lib / openecomp-zusammen-core / src / main / java / org / openecomp / core / zusammen / db / ZusammenConnector.java
1 package org.openecomp.core.zusammen.db;
2
3 import com.amdocs.zusammen.adaptor.inbound.api.types.item.Element;
4 import com.amdocs.zusammen.adaptor.inbound.api.types.item.ElementConflict;
5 import com.amdocs.zusammen.adaptor.inbound.api.types.item.ElementInfo;
6 import com.amdocs.zusammen.adaptor.inbound.api.types.item.ItemVersionConflict;
7 import com.amdocs.zusammen.adaptor.inbound.api.types.item.ZusammenElement;
8 import com.amdocs.zusammen.commons.health.data.HealthInfo;
9 import com.amdocs.zusammen.datatypes.Id;
10 import com.amdocs.zusammen.datatypes.SessionContext;
11 import com.amdocs.zusammen.datatypes.item.ElementContext;
12 import com.amdocs.zusammen.datatypes.item.Info;
13 import com.amdocs.zusammen.datatypes.item.Item;
14 import com.amdocs.zusammen.datatypes.item.ItemVersion;
15 import com.amdocs.zusammen.datatypes.item.ItemVersionData;
16 import com.amdocs.zusammen.datatypes.item.ItemVersionStatus;
17 import com.amdocs.zusammen.datatypes.item.Resolution;
18 import com.amdocs.zusammen.datatypes.itemversion.ItemVersionRevisions;
19 import com.amdocs.zusammen.datatypes.itemversion.Tag;
20
21 import java.util.Collection;
22
23 public interface ZusammenConnector {
24
25   Collection<HealthInfo> checkHealth(SessionContext sessionContext);
26
27   String getVersion(SessionContext sessionContext);
28
29   Collection<Item> listItems(SessionContext context);
30
31   Item getItem(SessionContext context, Id itemId);
32
33   Id createItem(SessionContext context, Info info);
34
35   void updateItem(SessionContext context, Id itemId, Info info);
36
37
38   Collection<ItemVersion> listPublicVersions(SessionContext context, Id itemId);
39
40   ItemVersion getPublicVersion(SessionContext context, Id itemId, Id versionId);
41
42   Id createVersion(SessionContext context, Id itemId, Id baseVersionId,
43                    ItemVersionData itemVersionData);
44
45   void updateVersion(SessionContext context, Id itemId, Id versionId,
46                      ItemVersionData itemVersionData);
47
48   ItemVersion getVersion(SessionContext context, Id itemId, Id versionId);
49
50   ItemVersionStatus getVersionStatus(SessionContext context, Id itemId, Id versionId);
51
52   void tagVersion(SessionContext context, Id itemId, Id versionId, Tag tag);
53
54   void resetVersionRevision(SessionContext context, Id itemId, Id versionId, Id revisionId);
55
56   void revertVersionRevision(SessionContext context, Id itemId, Id versionId, Id revisionId);
57
58   ItemVersionRevisions listVersionRevisions(SessionContext context, Id itemId, Id versionId);
59
60   void publishVersion(SessionContext context, Id itemId, Id versionId, String message);
61
62   void syncVersion(SessionContext context, Id itemId, Id versionId);
63
64   void forceSyncVersion(SessionContext context, Id itemId, Id versionId);
65
66   ItemVersionConflict getVersionConflict(SessionContext context, Id itemId, Id versionId);
67
68
69   Collection<ElementInfo> listElements(SessionContext context, ElementContext elementContext,
70                                        Id parentElementId);
71
72   ElementInfo getElementInfo(SessionContext context, ElementContext elementContext, Id elementId);
73
74   Element getElement(SessionContext context, ElementContext elementContext, Id elementId);
75
76   ElementConflict getElementConflict(SessionContext context, ElementContext elementContext,
77                                      Id elementId);
78
79   Element saveElement(SessionContext context, ElementContext elementContext,
80                       ZusammenElement element, String message);
81
82   void resolveElementConflict(SessionContext context, ElementContext elementContext,
83                               ZusammenElement element, Resolution resolution);
84
85   void resetVersionHistory(SessionContext context, Id itemId, Id versionId, String changeRef);
86 }