ca37b2200ae8d306f2e47a75a52e2a0186838956
[sdc.git] /
1 package org.openecomp.core.zusammen.api;
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 import java.util.Optional;
23
24 public interface ZusammenAdaptor {
25
26   Collection<Item> listItems(SessionContext context);
27
28   Item getItem(SessionContext context, Id itemId);
29
30   void deleteItem(SessionContext context, Id itemId);
31
32   Id createItem(SessionContext context, Info info);
33
34   void updateItem(SessionContext context, Id itemId, Info info);
35
36   // TODO: 4/4/2017 remove this workaround when versionId will be recieved from UI
37   Optional<ItemVersion> getFirstVersion(SessionContext context, Id itemId);
38
39   Collection<ItemVersion> listPublicVersions(SessionContext context, Id itemId);
40
41   ItemVersion getPublicVersion(SessionContext context, Id itemId, Id versionId);
42
43   Id createVersion(SessionContext context, Id itemId, Id baseVersionId,
44                    ItemVersionData itemVersionData);
45
46   void updateVersion(SessionContext context, Id itemId, Id versionId,
47                      ItemVersionData itemVersionData);
48
49   ItemVersion getVersion(SessionContext context, Id itemId, Id versionId);
50
51   ItemVersionStatus getVersionStatus(SessionContext context, Id itemId, Id versionId);
52
53   ItemVersionConflict getVersionConflict(SessionContext context, Id itemId, Id versionId);
54
55   void tagVersion(SessionContext context, Id itemId, Id versionId, Tag tag);
56
57   void resetVersionHistory(SessionContext context, Id itemId, Id versionId, String version);
58
59   void publishVersion(SessionContext context, Id itemId, Id versionId, String message);
60
61   void syncVersion(SessionContext context, Id itemId, Id versionId);
62
63   void forceSyncVersion(SessionContext context, Id itemId, Id versionId);
64
65   void cleanVersion(SessionContext context, Id itemId, Id versionId);
66
67   Optional<ElementInfo> getElementInfo(SessionContext context, ElementContext elementContext,
68                                        Id elementId);
69
70   Optional<Element> getElement(SessionContext context, ElementContext elementContext,
71                                String elementId); // TODO: 4/3/2017 change to Id
72
73   Optional<Element> getElementByName(SessionContext context, ElementContext elementContext,
74                                      Id parentElementId, String elementName);
75
76   Collection<ElementInfo> listElements(SessionContext context, ElementContext elementContext,
77                                        Id parentElementId);
78
79   Collection<Element> listElementData(SessionContext context, ElementContext elementContext,
80                                       Id parentElementId);
81
82   /**
83    * Lists the sub elements of the element named elementName which is a sub element of
84    * parentElementId
85    */
86   Collection<ElementInfo> listElementsByName(SessionContext context, ElementContext elementContext,
87                                              Id parentElementId, String elementName);
88
89   Optional<ElementInfo> getElementInfoByName(SessionContext context, ElementContext elementContext,
90                                              Id parentElementId, String elementName);
91
92   Optional<ElementConflict> getElementConflict(SessionContext context,
93                                                ElementContext elementContext, Id elementId);
94
95   Element saveElement(SessionContext context, ElementContext elementContext,
96                       ZusammenElement element, String message);
97
98   void resolveElementConflict(SessionContext context, ElementContext elementContext,
99                               ZusammenElement element, Resolution resolution);
100
101   void revert(SessionContext context, Id itemId, Id versionId, Id revisionId);
102
103   ItemVersionRevisions listRevisions(SessionContext context, Id itemId, Id versionId);
104
105   Collection<HealthInfo> checkHealth(SessionContext context);
106
107   String getVersion(SessionContext context);
108 }