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