Package com.commercetools.history.models.change_history

Interface ModifiedBy

public interface ModifiedBy

Information about the user or API Client who performed the change. This is a variant of LastModifiedBy.

Example to create an instance using the builder pattern 

     ModifiedBy modifiedBy = ModifiedBy.builder()
             .isPlatformClient(true)
             .type("{type}")
             .build()

  • Method Details

    • getIsPlatformClient

      @NotNull @NotNull Boolean getIsPlatformClient()

      true if the change was made using the Merchant Center or ImpEx.

      Returns:
      isPlatformClient

    • getId

      String getId()

      ID of the Merchant Center user who made the change.

      Present only if isPlatformClient is true.

      Returns:
      id

    • getType

      @NotNull @NotNull String getType()

      Indicates who performed the change.

      • If the change was made by a user, the value is "user".
      • If the change was made by an API Client with or without an external user ID, the value is "external-user".
      • If the change was made by an Associate, the value is "associate".
      Returns:
      type

    • getClientId

      String getClientId()

      ID of the API Client that made the change.

      Present only if the change was made using an API Client.

      Returns:
      clientId

    • getAnonymousId

      String getAnonymousId()

      Present only if the change was made using a token from an anonymous session.

      Returns:
      anonymousId

    • getCustomer

      @Valid @Valid Reference getCustomer()

      The Customer who made the change.

      Present only if the change was made using a token from the password flow.

      Returns:
      customer

    • getAssociate

      @Valid @Valid Reference getAssociate()

      The Associate who made the change in the context of a Business Unit. Present only if the Associate acts on behalf of a company using the associate endpoints.

      Returns:
      associate

    • setIsPlatformClient

      void setIsPlatformClient(Boolean isPlatformClient)

      true if the change was made using the Merchant Center or ImpEx.

      Parameters:
      isPlatformClient - value to be set

    • setId

      void setId(String id)

      ID of the Merchant Center user who made the change.

      Present only if isPlatformClient is true.

      Parameters:
      id - value to be set

    • setType

      void setType(String type)

      Indicates who performed the change.

      • If the change was made by a user, the value is "user".
      • If the change was made by an API Client with or without an external user ID, the value is "external-user".
      • If the change was made by an Associate, the value is "associate".
      Parameters:
      type - value to be set

    • setClientId

      void setClientId(String clientId)

      ID of the API Client that made the change.

      Present only if the change was made using an API Client.

      Parameters:
      clientId - value to be set

    • setAnonymousId

      void setAnonymousId(String anonymousId)

      Present only if the change was made using a token from an anonymous session.

      Parameters:
      anonymousId - value to be set

    • setCustomer

      void setCustomer(Reference customer)

      The Customer who made the change.

      Present only if the change was made using a token from the password flow.

      Parameters:
      customer - value to be set

    • setAssociate

      void setAssociate(Reference associate)

      The Associate who made the change in the context of a Business Unit. Present only if the Associate acts on behalf of a company using the associate endpoints.

      Parameters:
      associate - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ModifiedByBuilder builder()
      builder factory method for ModifiedBy
      Returns:
      builder

    • builder

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

    • withModifiedBy

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