gerrit.onap Code Review - sdc.git/blob

   1 /*
   2  * Copyright © 2016-2018 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.openecomp.sdc.versioning;
  18
  19 import java.util.List;
  20 import java.util.Map;
  21 import org.openecomp.sdc.versioning.dao.types.Revision;
  22 import org.openecomp.sdc.versioning.dao.types.Version;
  23 import org.openecomp.sdc.versioning.types.VersionCreationMethod;
  24 import org.openecomp.sdc.versioning.types.VersionInfo;
  25 import org.openecomp.sdc.versioning.types.VersionableEntityAction;
  26 import org.openecomp.sdc.versioning.types.VersionableEntityMetadata;
  27
  28 public interface ActionVersioningManager {
  29
  30   void register(String entityType, VersionableEntityMetadata entityMetadata);
  31
  32   Version create(String entityType, String entityId, String user);
  33
  34   void delete(String entityType, String entityId, String user);
  35
  36   void undoDelete(String entityType, String entityId, String user);
  37
  38   Version checkout(String entityType, String entityId, String user);
  39
  40   Version undoCheckout(String entityType, String entityId, String user);
  41
  42   Version checkin(String entityType, String entityId, String user, String checkinDescription);
  43
  44   Version submit(String entityType, String entityId, String user, String submitDescription);
  45
  46   VersionInfo getEntityVersionInfo(String entityType, String entityId, String user,
  47       VersionableEntityAction action);
  48
  49   Map<String, VersionInfo> listEntitiesVersionInfo(String entityType, String user,
  50       VersionableEntityAction action);
  51
  52   Map<String, VersionInfo> listDeletedEntitiesVersionInfo(String entityType, String user,
  53       VersionableEntityAction action);
  54
  55
  56   List<Version> list(String itemId); // TODO: 5/24/2017 filter (by status for example)
  57
  58   Version get(String itemId, Version version);
  59
  60   Version create(String itemId, Version version,
  61       VersionCreationMethod creationMethod);
  62
  63   void submit(String itemId, Version version, String submitDescription);
  64
  65   void publish(String itemId, Version version, String message);
  66
  67   void sync(String itemId, Version version);
  68
  69   void forceSync(String itemId, Version version);
  70
  71   void revert(String itemId, Version version, String revisionId);
  72
  73   List<Revision> listRevisions(String itemId, Version version);
  74
  75 }