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.ElementInfo;
   5 import com.amdocs.zusammen.adaptor.inbound.api.types.item.ZusammenElement;
   6 import com.amdocs.zusammen.commons.health.data.HealthInfo;
   7 import com.amdocs.zusammen.datatypes.Id;
   8 import com.amdocs.zusammen.datatypes.SessionContext;
   9 import com.amdocs.zusammen.datatypes.item.ElementContext;
  10 import com.amdocs.zusammen.datatypes.item.Info;
  11 import com.amdocs.zusammen.datatypes.item.Item;
  12 import com.amdocs.zusammen.datatypes.item.ItemVersion;
  13 import com.amdocs.zusammen.datatypes.item.ItemVersionData;
  14 import com.amdocs.zusammen.datatypes.itemversion.Tag;
  15 import org.apache.commons.lang3.tuple.ImmutablePair;
  16
  17 import java.util.Collection;
  18 import java.util.Optional;
  19
  20 public interface ZusammenAdaptor {
  21
  22   Collection<Item> listItems(SessionContext context);
  23
  24   Id createItem(SessionContext context, Info info);
  25
  26   void updateItem(SessionContext context, Id itemId, Info info);
  27
  28   // TODO: 4/4/2017 fix this workaround when versionId will be recieved from UI
  29   Optional<ItemVersion> getFirstVersion(SessionContext context, Id itemId);
  30
  31   Id createVersion(SessionContext context, Id itemId, Id baseVersionId,
  32                    ItemVersionData itemVersionData);
  33
  34   void updateVersion(SessionContext context, Id itemId, Id versionId,
  35                      ItemVersionData itemVersionData);
  36
  37   void tagVersion(SessionContext context, Id itemId, Id versionId, Tag tag);
  38
  39   void resetVersionHistory(SessionContext context, Id itemId, Id versionId, String changeRef);
  40
  41   Optional<ElementInfo> getElementInfo(SessionContext context, ElementContext elementContext,
  42                                        Id elementId);
  43
  44   Optional<Element> getElement(SessionContext context, ElementContext elementContext,
  45                                String elementId); // TODO: 4/3/2017 change to Id
  46
  47   Optional<Element> getElementByName(
  48       SessionContext context, ElementContext elementContext, Id parentElementId,
  49       String elementName);
  50
  51   Collection<ElementInfo> listElements(SessionContext context,
  52                                        ElementContext elementContext,
  53                                        Id parentElementId);
  54
  55   Collection<Element> listElementData(SessionContext context,
  56                                       ElementContext elementContext,
  57                                       Id parentElementId);
  58
  59   /**
  60    * Lists the sub elements of the element named <elementName> which is a sub element of <parentElementId>
  61    * @param context
  62    * @param elementContext
  63    * @param parentElementId
  64    * @param elementName
  65    * @return
  66    */
  67   Collection<ElementInfo> listElementsByName(
  68       SessionContext context, ElementContext elementContext, Id parentElementId,
  69       String elementName);
  70
  71   Optional<ElementInfo> getElementInfoByName(
  72       SessionContext context, ElementContext elementContext, Id parentElementId,
  73       String elementName);
  74
  75   Optional<Element> saveElement(SessionContext context, ElementContext elementContext,
  76                                 ZusammenElement element, String message);
  77
  78   Collection<HealthInfo> checkHealth(SessionContext context);
  79
  80   String getVersion(SessionContext sessionContext);
  81 }