vid-app-common/src/main/java/org/onap/vid/job/Job.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * VID
   4  * ================================================================================
   5  * Copyright (C) 2017 - 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.vid.job;
  22
  23 import com.fasterxml.jackson.annotation.JsonIgnore;
  24 import org.onap.vid.job.impl.JobSharedData;
  25
  26 import java.util.Map;
  27 import java.util.UUID;
  28
  29 public interface Job {
  30
  31     UUID getUuid();
  32
  33     void setUuid(UUID uuid);
  34
  35     JobStatus getStatus();
  36
  37     void setStatus(JobStatus status);
  38
  39     @JsonIgnore
  40     Map<String, Object> getData();
  41
  42     JobSharedData getSharedData();
  43
  44     void setTypeAndData(JobType jobType, Map<String, Object> data);
  45
  46     UUID getTemplateId();
  47
  48     void setTemplateId(UUID templateId);
  49
  50     Integer getIndexInBulk();
  51
  52     void setIndexInBulk(Integer indexInBulk);
  53
  54     JobType getType();
  55
  56     enum JobStatus {
  57         COMPLETED(true, false),
  58         FAILED(true, true),
  59         IN_PROGRESS(false),
  60         RESOURCE_IN_PROGRESS(false),
  61         PAUSE(false),
  62         PENDING(false),
  63         STOPPED(true, true),
  64         COMPLETED_WITH_ERRORS(true, true),
  65         COMPLETED_WITH_NO_ACTION(true, false),
  66         CREATING(false);
  67
  68         private final Boolean finalStatus;
  69         public Boolean isFinal(){return finalStatus;}
  70
  71         private final Boolean failure;
  72         public Boolean isFailure() {
  73             return failure;
  74         }
  75
  76         JobStatus(Boolean finalStatus)
  77         {
  78             this(finalStatus, false);
  79         }
  80
  81         JobStatus(Boolean finalStatus, boolean failure) {
  82             this.finalStatus = finalStatus;
  83             this.failure = failure;
  84         }
  85
  86     }
  87 }