Add collaboration feature
[sdc.git] / openecomp-be / lib / openecomp-core-lib / openecomp-zusammen-lib / openecomp-zusammen-api / src / main / java / org / openecomp / core / zusammen / api / ZusammenAdaptor.java
index 2ba447f..35c07cb 100644 (file)
@@ -1,7 +1,9 @@
 package org.openecomp.core.zusammen.api;
 
 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.adaptor.inbound.api.types.item.ZusammenElement;
 import com.amdocs.zusammen.commons.health.data.HealthInfo;
 import com.amdocs.zusammen.datatypes.Id;
@@ -11,31 +13,53 @@ 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.Tag;
+import org.openecomp.sdc.versioning.dao.types.Revision;
 
 import java.util.Collection;
+import java.util.List;
 import java.util.Optional;
 
 public interface ZusammenAdaptor {
 
   Collection<Item> listItems(SessionContext context);
 
+  Item getItem(SessionContext context, Id itemId);
+
   Id createItem(SessionContext context, Info info);
 
   void updateItem(SessionContext context, Id itemId, Info info);
 
-  // TODO: 4/4/2017 fix this workaround when versionId will be recieved from UI
+  // TODO: 4/4/2017 remove this workaround when versionId will be recieved from UI
   Optional<ItemVersion> getFirstVersion(SessionContext context, Id itemId);
 
+  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);
+
+  ItemVersionConflict getVersionConflict(SessionContext context, Id itemId, Id versionId);
+
   void tagVersion(SessionContext context, Id itemId, Id versionId, Tag tag);
 
-  void resetVersionHistory(SessionContext context, Id itemId, Id versionId, String changeRef);
+  void resetVersionHistory(SessionContext context, Id itemId, Id versionId, String version);
+
+  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);
 
   Optional<ElementInfo> getElementInfo(SessionContext context, ElementContext elementContext,
                                        Id elementId);
@@ -43,38 +67,39 @@ public interface ZusammenAdaptor {
   Optional<Element> getElement(SessionContext context, ElementContext elementContext,
                                String elementId); // TODO: 4/3/2017 change to Id
 
-  Optional<Element> getElementByName(
-      SessionContext context, ElementContext elementContext, Id parentElementId,
-      String elementName);
+  Optional<Element> getElementByName(SessionContext context, ElementContext elementContext,
+                                     Id parentElementId, String elementName);
 
-  Collection<ElementInfo> listElements(SessionContext context,
-                                       ElementContext elementContext,
+  Collection<ElementInfo> listElements(SessionContext context, ElementContext elementContext,
                                        Id parentElementId);
 
-  Collection<Element> listElementData(SessionContext context,
-                                      ElementContext elementContext,
+  Collection<Element> listElementData(SessionContext context, ElementContext elementContext,
                                       Id parentElementId);
 
   /**
-   * Lists the sub elements of the element named <elementName> which is a sub element of <parentElementId>
-   * @param context
-   * @param elementContext
-   * @param parentElementId
-   * @param elementName
-   * @return
+   * Lists the sub elements of the element named elementName which is a sub element of
+   * parentElementId
    */
-  Collection<ElementInfo> listElementsByName(
-      SessionContext context, ElementContext elementContext, Id parentElementId,
-      String elementName);
+  Collection<ElementInfo> listElementsByName(SessionContext context, ElementContext elementContext,
+                                             Id parentElementId, String elementName);
+
+  Optional<ElementInfo> getElementInfoByName(SessionContext context, ElementContext elementContext,
+                                             Id parentElementId, String elementName);
 
-  Optional<ElementInfo> getElementInfoByName(
-      SessionContext context, ElementContext elementContext, Id parentElementId,
-      String elementName);
+  Optional<ElementConflict> getElementConflict(SessionContext context,
+                                               ElementContext elementContext, Id elementId);
 
-  Optional<Element> saveElement(SessionContext context, ElementContext elementContext,
-                                ZusammenElement element, String message);
+  Element saveElement(SessionContext context, ElementContext elementContext,
+                      ZusammenElement element, String message);
+
+  void resolveElementConflict(SessionContext context, ElementContext elementContext,
+                              ZusammenElement element, Resolution resolution);
 
   Collection<HealthInfo> checkHealth(SessionContext context);
 
-  String getVersion(SessionContext sessionContext);
+  String getVersion(SessionContext context);
+
+  void revert(SessionContext sessionContext, String itemId, String versionId, String revisionId);
+
+  List<Revision> listRevisions(SessionContext sessionContext, String itemId, String versionId);
 }