io.resys.hdes.client.api.programs.FlowProgram Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hdes-client-api Show documentation
There is a newer version: 3.130.78
package io.resys.hdes.client.api.programs;

/*-
 * #%L
 * wrench-assets-flow
 * %%
 * Copyright (C) 2016 - 2018 Copyright 2016 ReSys OÜ
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import java.io.Serializable;
import java.time.LocalDateTime;
import java.util.Collection;
import java.util.List;
import java.util.Map;

import javax.annotation.Nullable;

import org.immutables.value.Value;

import io.resys.hdes.client.api.ast.TypeDef;

@Value.Immutable
public interface FlowProgram extends Program {
  Collection getAcceptDefs();
  String getStartStepId();
  Map getSteps();

  @Value.Immutable
  interface FlowProgramStep extends Serializable {
    String getId();
    FlowProgramStepPointer getPointer();
    @Nullable
    FlowProgramStepBody getBody();
  }
  
  @Value.Immutable
  interface FlowProgramStepBody extends Serializable {
    String getRef();
    FlowProgramStepRefType getRefType();
    Map getInputMapping();
    Boolean getCollection();
  }
  interface FlowProgramStepPointer extends Serializable {
    FlowProgramStepPointerType getType();
  }
  @Value.Immutable
  interface FlowProgramStepEndPointer extends FlowProgramStepPointer {
  }
  @Value.Immutable
  interface FlowProgramStepThenPointer extends FlowProgramStepPointer {
    String getStepId();
  }
  @Value.Immutable
  interface FlowProgramStepWhenThenPointer extends FlowProgramStepPointer {
    List getConditions();
  }
  @Value.Immutable  
  interface FlowProgramStepConditionalThenPointer {
    @Nullable
    ExpressionProgram getExpression();
    String getStepId();
  }
  
  @Value.Immutable
  interface FlowResult extends ProgramResult {
    String getStepId();
    String getShortHistory();
    List getLogs();
    FlowExecutionStatus getStatus();
    Map getAccepts();
    Map getReturns();
  }

  @Value.Immutable
  interface FlowResultLog extends Serializable {
    Integer getId();
    String getStepId();
    LocalDateTime getStart();
    LocalDateTime getEnd();
    List getErrors();
    FlowExecutionStatus getStatus();
    Map getAccepts();
    Map getReturns();
    @Nullable
    Serializable getReturnsValue();
  }
  
  @Value.Immutable
  interface FlowResultErrorLog extends Serializable {
    String getId();
    String getMsg();
  }
  
  enum FlowProgramStepPointerType { SWITCH, THEN, END }
  enum FlowProgramStepRefType { SERVICE, DT } 
  enum FlowExecutionStatus { COMPLETED, ERROR }
}