Package com.commercetools.api.models.associate_role

Interface AssociateRoleDraft

All Superinterfaces:
Draft<AssociateRoleDraft>
public interface AssociateRoleDraft extends Draft<AssociateRoleDraft>
AssociateRoleDraft
Example to create an instance using the builder pattern 

     AssociateRoleDraft associateRoleDraft = AssociateRoleDraft.builder()
             .key("{key}")
             .build()

  • Method Details

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique and immutable identifier for the AssociateRole.

      Returns:
      key

    • getName

      String getName()

      Name of the AssociateRole.

      Returns:
      name

    • getBuyerAssignable

      Boolean getBuyerAssignable()

      Whether the AssociateRole can be assigned to an Associate by a buyer.

      Returns:
      buyerAssignable

    • getPermissions

      List<Permission> getPermissions()

      List of Permissions for the AssociateRole.

      Returns:
      permissions

    • getCustom

      @Valid @Valid CustomFieldsDraft getCustom()

      Custom Fields for the AssociateRole.

      Returns:
      custom

    • setKey

      void setKey(String key)

      User-defined unique and immutable identifier for the AssociateRole.

      Parameters:
      key - value to be set

    • setName

      void setName(String name)

      Name of the AssociateRole.

      Parameters:
      name - value to be set

    • setBuyerAssignable

      void setBuyerAssignable(Boolean buyerAssignable)

      Whether the AssociateRole can be assigned to an Associate by a buyer.

      Parameters:
      buyerAssignable - value to be set

    • setPermissions

      void setPermissions(Permission... permissions)

      List of Permissions for the AssociateRole.

      Parameters:
      permissions - values to be set

    • setPermissions

      void setPermissions(List<Permission> permissions)

      List of Permissions for the AssociateRole.

      Parameters:
      permissions - values to be set

    • setCustom

      void setCustom(CustomFieldsDraft custom)

      Custom Fields for the AssociateRole.

      Parameters:
      custom - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static AssociateRoleDraftBuilder builder()
      builder factory method for AssociateRoleDraft
      Returns:
      builder

    • builder

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

    • withAssociateRoleDraft

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