Package com.commercetools.api.models.order

Interface OrderUpdateSyncInfoAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>
All Known Implementing Classes:
OrderUpdateSyncInfoActionImpl
public interface OrderUpdateSyncInfoAction extends OrderUpdateAction
OrderUpdateSyncInfoAction
Example to create an instance using the builder pattern 

     OrderUpdateSyncInfoAction orderUpdateSyncInfoAction = OrderUpdateSyncInfoAction.builder()
             .channel(channelBuilder -> channelBuilder)
             .build()

  • Field Details

    • UPDATE_SYNC_INFO

      static final String UPDATE_SYNC_INFO
      discriminator value for OrderUpdateSyncInfoAction
      See Also:

  • Method Details

    • getExternalId

      String getExternalId()

      Set this to identify an external order instance, file, or other resource.

      Returns:
      externalId

    • getChannel

      @NotNull @Valid @NotNull @Valid ChannelResourceIdentifier getChannel()

      The synchronization destination to set. Must not be empty. The referenced Channel must have the Channel Role OrderExport or OrderImport. Otherwise this update action returns an InvalidInput error.

      Returns:
      channel

    • getSyncedAt

      ZonedDateTime getSyncedAt()

      If not set, it defaults to the current date and time.

      Returns:
      syncedAt

    • setExternalId

      void setExternalId(String externalId)

      Set this to identify an external order instance, file, or other resource.

      Parameters:
      externalId - value to be set

    • setChannel

      void setChannel(ChannelResourceIdentifier channel)

      The synchronization destination to set. Must not be empty. The referenced Channel must have the Channel Role OrderExport or OrderImport. Otherwise this update action returns an InvalidInput error.

      Parameters:
      channel - value to be set

    • setSyncedAt

      void setSyncedAt(ZonedDateTime syncedAt)

      If not set, it defaults to the current date and time.

      Parameters:
      syncedAt - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderUpdateSyncInfoActionBuilder builder()
      builder factory method for OrderUpdateSyncInfoAction
      Returns:
      builder

    • builder

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

    • withOrderUpdateSyncInfoAction

      default <T> T withOrderUpdateSyncInfoAction(Function<OrderUpdateSyncInfoAction,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<OrderUpdateSyncInfoAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference