Package com.commercetools.history.models.change_history

Class ModifiedByImpl

java.lang.Object
com.commercetools.history.models.change_history.ModifiedByImpl
All Implemented Interfaces:
ModifiedBy, io.vrap.rmf.base.client.ModelBase
public class ModifiedByImpl extends Object implements ModifiedBy, io.vrap.rmf.base.client.ModelBase

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

  • Nested Class Summary

    Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

    io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModifiedByImpl()
    create empty instance

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    String
    getAnonymousId()
    Present only if the change was made using a token from an anonymous session.
    Reference
    getAssociate()
    The Associate who made the change in the context of a Business Unit.
    String
    getClientId()
    ID of the API Client that made the change.
    Reference
    getCustomer()
    The Customer who made the change.
    String
    getId()
    ID of the Merchant Center user who made the change.
    Boolean
    getIsPlatformClient()
    true if the change was made using the Merchant Center or ImpEx.
    String
    getType()
    Indicates who performed the change.
    int
    hashCode()
     
    void
    setAnonymousId(String anonymousId)
    Present only if the change was made using a token from an anonymous session.
    void
    setAssociate(Reference associate)
    The Associate who made the change in the context of a Business Unit.
    void
    setClientId(String clientId)
    ID of the API Client that made the change.
    void
    setCustomer(Reference customer)
    The Customer who made the change.
    void
    setId(String id)
    ID of the Merchant Center user who made the change.
    void
    setIsPlatformClient(Boolean isPlatformClient)
    true if the change was made using the Merchant Center or ImpEx.
    void
    setType(String type)
    Indicates who performed the change.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface io.vrap.rmf.base.client.ModelBase

    reflectionString, reflectionString

    Methods inherited from interface com.commercetools.history.models.change_history.ModifiedBy

    withModifiedBy

  • Constructor Details

    • ModifiedByImpl

      public ModifiedByImpl()
      create empty instance

  • Method Details

    • getId

      public String getId()

      ID of the Merchant Center user who made the change.

      Present only if the change was made in the Merchant Center.

      Specified by:
      getId in interface ModifiedBy
      Returns:
      id

    • getType

      public 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".
      Specified by:
      getType in interface ModifiedBy
      Returns:
      type

    • getClientId

      public String getClientId()

      ID of the API Client that made the change.

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

      Specified by:
      getClientId in interface ModifiedBy
      Returns:
      clientId

    • getAnonymousId

      public String getAnonymousId()

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

      Specified by:
      getAnonymousId in interface ModifiedBy
      Returns:
      anonymousId

    • getCustomer

      public Reference getCustomer()

      The Customer who made the change.

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

      Specified by:
      getCustomer in interface ModifiedBy
      Returns:
      customer

    • getAssociate

      public 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.

      Specified by:
      getAssociate in interface ModifiedBy
      Returns:
      associate

    • getIsPlatformClient

      public Boolean getIsPlatformClient()

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

      Specified by:
      getIsPlatformClient in interface ModifiedBy
      Returns:
      isPlatformClient

    • setId

      public void setId(String id)
      Description copied from interface: ModifiedBy

      ID of the Merchant Center user who made the change.

      Present only if the change was made in the Merchant Center.

      Specified by:
      setId in interface ModifiedBy
      Parameters:
      id - value to be set

    • setType

      public void setType(String type)
      Description copied from interface: ModifiedBy

      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".
      Specified by:
      setType in interface ModifiedBy
      Parameters:
      type - value to be set

    • setClientId

      public void setClientId(String clientId)
      Description copied from interface: ModifiedBy

      ID of the API Client that made the change.

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

      Specified by:
      setClientId in interface ModifiedBy
      Parameters:
      clientId - value to be set

    • setAnonymousId

      public void setAnonymousId(String anonymousId)
      Description copied from interface: ModifiedBy

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

      Specified by:
      setAnonymousId in interface ModifiedBy
      Parameters:
      anonymousId - value to be set

    • setCustomer

      public void setCustomer(Reference customer)
      Description copied from interface: ModifiedBy

      The Customer who made the change.

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

      Specified by:
      setCustomer in interface ModifiedBy
      Parameters:
      customer - value to be set

    • setAssociate

      public void setAssociate(Reference associate)
      Description copied from interface: ModifiedBy

      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.

      Specified by:
      setAssociate in interface ModifiedBy
      Parameters:
      associate - value to be set

    • setIsPlatformClient

      public void setIsPlatformClient(Boolean isPlatformClient)
      Description copied from interface: ModifiedBy

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

      Specified by:
      setIsPlatformClient in interface ModifiedBy
      Parameters:
      isPlatformClient - value to be set

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object