Interface OrderEdit

All Superinterfaces:
BaseResource, Customizable<OrderEdit>, DomainResource<OrderEdit>, Identifiable<OrderEdit>, OrderEditMixin, Referencable<OrderEdit>, ResourceIdentifiable<OrderEdit>, Versioned<OrderEdit>, WithKey

OrderEdit
Example to create an instance using the builder pattern

     OrderEdit orderEdit = OrderEdit.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .resource(resourceBuilder -> resourceBuilder)
             .plusStagedActions(stagedActionsBuilder -> stagedActionsBuilder)
             .result(resultBuilder -> resultBuilder)
             .build()
 
  • Method Details

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the Order Edit.

      Specified by:
      getId in interface BaseResource
      Specified by:
      getId in interface DomainResource<OrderEdit>
      Specified by:
      getId in interface Identifiable<OrderEdit>
      Specified by:
      getId in interface Versioned<OrderEdit>
      Returns:
      id
    • getVersion

      @NotNull @NotNull Long getVersion()

      Current version of the Order Edit.

      Specified by:
      getVersion in interface BaseResource
      Specified by:
      getVersion in interface DomainResource<OrderEdit>
      Specified by:
      getVersion in interface Versioned<OrderEdit>
      Returns:
      version
    • getKey

      String getKey()

      User-defined unique identifier of the Order Edit.

      Specified by:
      getKey in interface WithKey
      Returns:
      key
    • getResource

      @NotNull @Valid @NotNull @Valid OrderReference getResource()

      Reference to the Order updated with this edit.

      Returns:
      resource
    • getStagedActions

      @NotNull @Valid @NotNull @Valid List<StagedOrderUpdateAction> getStagedActions()

      Update actions applied to the Order referenced by resource.

      Returns:
      stagedActions
    • getResult

      @NotNull @Valid @NotNull @Valid OrderEditResult getResult()

      For applied edits, it's a summary of the changes on the Order. For unapplied edits, it's a preview of the changes.

      Returns:
      result
    • getComment

      String getComment()

      User-defined information regarding the Order Edit.

      Returns:
      comment
    • getCustom

      @Valid @Valid CustomFields getCustom()

      Custom Fields of the Order Edit.

      Specified by:
      getCustom in interface Customizable<OrderEdit>
      Returns:
      custom
    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

      Date and time (UTC) the Order Edit was initially created.

      Specified by:
      getCreatedAt in interface BaseResource
      Returns:
      createdAt
    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

      Date and time (UTC) the Order Edit was last updated.

      Specified by:
      getLastModifiedAt in interface BaseResource
      Returns:
      lastModifiedAt
    • getLastModifiedBy

      @Valid @Valid LastModifiedBy getLastModifiedBy()

      Present on resources created after 1 February 2019 except for events not tracked.

      Returns:
      lastModifiedBy
    • getCreatedBy

      @Valid @Valid CreatedBy getCreatedBy()

      Present on resources created after 1 February 2019 except for events not tracked.

      Returns:
      createdBy
    • setId

      void setId(String id)

      Unique identifier of the Order Edit.

      Specified by:
      setId in interface BaseResource
      Parameters:
      id - value to be set
    • setVersion

      void setVersion(Long version)

      Current version of the Order Edit.

      Specified by:
      setVersion in interface BaseResource
      Parameters:
      version - value to be set
    • setKey

      void setKey(String key)

      User-defined unique identifier of the Order Edit.

      Parameters:
      key - value to be set
    • setResource

      void setResource(OrderReference resource)

      Reference to the Order updated with this edit.

      Parameters:
      resource - value to be set
    • setStagedActions

      void setStagedActions(StagedOrderUpdateAction... stagedActions)

      Update actions applied to the Order referenced by resource.

      Parameters:
      stagedActions - values to be set
    • setStagedActions

      void setStagedActions(List<StagedOrderUpdateAction> stagedActions)

      Update actions applied to the Order referenced by resource.

      Parameters:
      stagedActions - values to be set
    • setResult

      void setResult(OrderEditResult result)

      For applied edits, it's a summary of the changes on the Order. For unapplied edits, it's a preview of the changes.

      Parameters:
      result - value to be set
    • setComment

      void setComment(String comment)

      User-defined information regarding the Order Edit.

      Parameters:
      comment - value to be set
    • setCustom

      void setCustom(CustomFields custom)

      Custom Fields of the Order Edit.

      Specified by:
      setCustom in interface Customizable<OrderEdit>
      Parameters:
      custom - value to be set
    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

      Date and time (UTC) the Order Edit was initially created.

      Specified by:
      setCreatedAt in interface BaseResource
      Parameters:
      createdAt - value to be set
    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

      Date and time (UTC) the Order Edit was last updated.

      Specified by:
      setLastModifiedAt in interface BaseResource
      Parameters:
      lastModifiedAt - value to be set
    • setLastModifiedBy

      void setLastModifiedBy(LastModifiedBy lastModifiedBy)

      Present on resources created after 1 February 2019 except for events not tracked.

      Parameters:
      lastModifiedBy - value to be set
    • setCreatedBy

      void setCreatedBy(CreatedBy createdBy)

      Present on resources created after 1 February 2019 except for events not tracked.

      Parameters:
      createdBy - value to be set
    • of

      static OrderEdit of()
      factory method
      Returns:
      instance of OrderEdit
    • of

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

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

      static OrderEditBuilder builder()
      builder factory method for OrderEdit
      Returns:
      builder
    • builder

      static OrderEditBuilder builder(OrderEdit template)
      create builder for OrderEdit instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withOrderEdit

      default <T> T withOrderEdit(Function<OrderEdit,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value
    • referenceTypeId

      static ReferenceTypeId referenceTypeId()
    • typeReference

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