gerrit.onap Code Review - sdc.git/blob

   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   Optional<ElementInfo> getElementInfo(SessionContext context, ElementContext elementContext,
  66                                        Id elementId);
  67
  68   Optional<Element> getElement(SessionContext context, ElementContext elementContext,
  69                                String elementId); // TODO: 4/3/2017 change to Id
  70
  71   Optional<Element> getElementByName(SessionContext context, ElementContext elementContext,
  72                                      Id parentElementId, String elementName);
  73
  74   Collection<ElementInfo> listElements(SessionContext context, ElementContext elementContext,
  75                                        Id parentElementId);
  76
  77   Collection<Element> listElementData(SessionContext context, ElementContext elementContext,
  78                                       Id parentElementId);
  79
  80   /**
  81    * Lists the sub elements of the element named elementName which is a sub element of
  82    * parentElementId
  83    */
  84   Collection<ElementInfo> listElementsByName(SessionContext context, ElementContext elementContext,
  85                                              Id parentElementId, String elementName);
  86
  87   Optional<ElementInfo> getElementInfoByName(SessionContext context, ElementContext elementContext,
  88                                              Id parentElementId, String elementName);
  89
  90   Optional<ElementConflict> getElementConflict(SessionContext context,
  91                                                ElementContext elementContext, Id elementId);
  92
  93   Element saveElement(SessionContext context, ElementContext elementContext,
  94                       ZusammenElement element, String message);
  95
  96   void resolveElementConflict(SessionContext context, ElementContext elementContext,
  97                               ZusammenElement element, Resolution resolution);
  98
  99   void revert(SessionContext context, Id itemId, Id versionId, Id revisionId);
 100
 101   ItemVersionRevisions listRevisions(SessionContext context, Id itemId, Id versionId);
 102
 103   Collection<HealthInfo> checkHealth(SessionContext context);
 104
 105   String getVersion(SessionContext context);
 106 }