Package com.commercetools.api.models.approval_flow

Interface ApprovalFlowUpdate

public interface ApprovalFlowUpdate
ApprovalFlowUpdate
Example to create an instance using the builder pattern 

     ApprovalFlowUpdate approvalFlowUpdate = ApprovalFlowUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()

  • Method Details

    • getVersion

      @NotNull @NotNull Long getVersion()

      Expected version of the Approval Flow to which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

      Returns:
      version

    • getActions

      @NotNull @Valid @NotNull @Valid List<ApprovalFlowUpdateAction> getActions()

      Update actions to be performed on the Approval Flow.

      Returns:
      actions

    • setVersion

      void setVersion(Long version)

      Expected version of the Approval Flow to which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

      Parameters:
      version - value to be set

    • setActions

      void setActions(ApprovalFlowUpdateAction... actions)

      Update actions to be performed on the Approval Flow.

      Parameters:
      actions - values to be set

    • setActions

      void setActions(List<ApprovalFlowUpdateAction> actions)

      Update actions to be performed on the Approval Flow.

      Parameters:
      actions - values to be set

    • of

      static ApprovalFlowUpdate of()
      factory method
      Returns:
      instance of ApprovalFlowUpdate

    • of

      static ApprovalFlowUpdate of(ApprovalFlowUpdate template)
      factory method to create a shallow copy ApprovalFlowUpdate
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ApprovalFlowUpdate copyDeep()

    • deepCopy

      @Nullable static ApprovalFlowUpdate deepCopy(@Nullable ApprovalFlowUpdate template)
      factory method to create a deep copy of ApprovalFlowUpdate
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ApprovalFlowUpdateBuilder builder()
      builder factory method for ApprovalFlowUpdate
      Returns:
      builder

    • builder

      static ApprovalFlowUpdateBuilder builder(ApprovalFlowUpdate template)
      create builder for ApprovalFlowUpdate instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withApprovalFlowUpdate

      default <T> T withApprovalFlowUpdate(Function<ApprovalFlowUpdate,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ApprovalFlowUpdate> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference