Package com.commercetools.api.models.channel

Interface ChannelSetRolesAction

All Superinterfaces:
ChannelUpdateAction, ResourceUpdateAction<ChannelUpdateAction>
public interface ChannelSetRolesAction extends ChannelUpdateAction
ChannelSetRolesAction
Example to create an instance using the builder pattern 

     ChannelSetRolesAction channelSetRolesAction = ChannelSetRolesAction.builder()
             .plusRoles(rolesBuilder -> rolesBuilder)
             .build()

  • Field Details

  • Method Details

    • getRoles

      @NotNull @NotNull List<ChannelRoleEnum> getRoles()

      Value to set. If set to an empty array, an InvalidOperation error is returned.

      If the new value is the same as the current value, an InvalidOperation error is returned.

      Returns:
      roles

    • setRoles

      void setRoles(ChannelRoleEnum... roles)

      Value to set. If set to an empty array, an InvalidOperation error is returned.

      If the new value is the same as the current value, an InvalidOperation error is returned.

      Parameters:
      roles - values to be set

    • setRoles

      void setRoles(List<ChannelRoleEnum> roles)

      Value to set. If set to an empty array, an InvalidOperation error is returned.

      If the new value is the same as the current value, an InvalidOperation error is returned.

      Parameters:
      roles - values to be set

    • of

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

    • of

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

    • copyDeep

      ChannelSetRolesAction copyDeep()
      Specified by:
      copyDeep in interface ChannelUpdateAction

    • deepCopy

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

    • builder

      static ChannelSetRolesActionBuilder builder()
      builder factory method for ChannelSetRolesAction
      Returns:
      builder

    • builder

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

    • withChannelSetRolesAction

      default <T> T withChannelSetRolesAction(Function<ChannelSetRolesAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<ChannelSetRolesAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference