openecomp-be/lib/openecomp-core-lib/openecomp-zusammen-lib/openecomp-zusammen-api/src/main/java/org/openecomp/core/zusammen/api/ZusammenAdaptor.java

   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.Tag;
  19 import org.openecomp.sdc.versioning.dao.types.Revision;
  20
  21 import java.util.Collection;
  22 import java.util.List;
  23 import java.util.Optional;
  24
  25 public interface ZusammenAdaptor {
  26
  27   Collection<Item> listItems(SessionContext context);
  28
  29   Item getItem(SessionContext context, Id itemId);
  30
  31   Id createItem(SessionContext context, Info info);
  32
  33   void updateItem(SessionContext context, Id itemId, Info info);
  34
  35   // TODO: 4/4/2017 remove this workaround when versionId will be recieved from UI
  36   Optional<ItemVersion> getFirstVersion(SessionContext context, Id itemId);
  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   ItemVersionConflict getVersionConflict(SessionContext context, Id itemId, Id versionId);
  53
  54   void tagVersion(SessionContext context, Id itemId, Id versionId, Tag tag);
  55
  56   void resetVersionHistory(SessionContext context, Id itemId, Id versionId, String version);
  57
  58   void publishVersion(SessionContext context, Id itemId, Id versionId, String message);
  59
  60   void syncVersion(SessionContext context, Id itemId, Id versionId);
  61
  62   void forceSyncVersion(SessionContext context, Id itemId, Id versionId);
  63
  64   Optional<ElementInfo> getElementInfo(SessionContext context, ElementContext elementContext,
  65                                        Id elementId);
  66
  67   Optional<Element> getElement(SessionContext context, ElementContext elementContext,
  68                                String elementId); // TODO: 4/3/2017 change to Id
  69
  70   Optional<Element> getElementByName(SessionContext context, ElementContext elementContext,
  71                                      Id parentElementId, String elementName);
  72
  73   Collection<ElementInfo> listElements(SessionContext context, ElementContext elementContext,
  74                                        Id parentElementId);
  75
  76   Collection<Element> listElementData(SessionContext context, ElementContext elementContext,
  77                                       Id parentElementId);
  78
  79   /**
  80    * Lists the sub elements of the element named elementName which is a sub element of
  81    * parentElementId
  82    */
  83   Collection<ElementInfo> listElementsByName(SessionContext context, ElementContext elementContext,
  84                                              Id parentElementId, String elementName);
  85
  86   Optional<ElementInfo> getElementInfoByName(SessionContext context, ElementContext elementContext,
  87                                              Id parentElementId, String elementName);
  88
  89   Optional<ElementConflict> getElementConflict(SessionContext context,
  90                                                ElementContext elementContext, Id elementId);
  91
  92   Element saveElement(SessionContext context, ElementContext elementContext,
  93                       ZusammenElement element, String message);
  94
  95   void resolveElementConflict(SessionContext context, ElementContext elementContext,
  96                               ZusammenElement element, Resolution resolution);
  97
  98   Collection<HealthInfo> checkHealth(SessionContext context);
  99
 100   String getVersion(SessionContext context);
 101
 102   void revert(SessionContext sessionContext, String itemId, String versionId, String revisionId);
 103
 104   List<Revision> listRevisions(SessionContext sessionContext, String itemId, String versionId);
 105 }