Package com.commercetools.api.models.category

Interface CategorySetExternalIdAction

All Superinterfaces:
CategoryUpdateAction, ResourceUpdateAction<CategoryUpdateAction>
public interface CategorySetExternalIdAction extends CategoryUpdateAction

This update action sets a new ID that can be used as an additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).

Example to create an instance using the builder pattern 

     CategorySetExternalIdAction categorySetExternalIdAction = CategorySetExternalIdAction.builder()
             .build()

  • Field Details

    • SET_EXTERNAL_ID

      static final String SET_EXTERNAL_ID
      discriminator value for CategorySetExternalIdAction
      See Also:

  • Method Details

    • getExternalId

      String getExternalId()

      Value to set. If empty, any existing value will be removed.

      Returns:
      externalId

    • setExternalId

      void setExternalId(String externalId)

      Value to set. If empty, any existing value will be removed.

      Parameters:
      externalId - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static CategorySetExternalIdActionBuilder builder()
      builder factory method for CategorySetExternalIdAction
      Returns:
      builder

    • builder

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

    • withCategorySetExternalIdAction

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