Package com.commercetools.api.models.channel

Interface ChannelRemoveRolesAction

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

     ChannelRemoveRolesAction channelRemoveRolesAction = ChannelRemoveRolesAction.builder()
             .plusRoles(rolesBuilder -> rolesBuilder)
             .build()

  • Field Details

  • Method Details

    • getRoles

      @NotNull @NotNull List<ChannelRoleEnum> getRoles()

      Value to remove from the array.

      If none of the specified roles are already present, an InvalidOperation error is returned.

      If all roles from the Channel are removed, an InvalidOperation error is returned.

      Returns:
      roles

    • setRoles

      void setRoles(ChannelRoleEnum... roles)

      Value to remove from the array.

      If none of the specified roles are already present, an InvalidOperation error is returned.

      If all roles from the Channel are removed, an InvalidOperation error is returned.

      Parameters:
      roles - values to be set

    • setRoles

      void setRoles(List<ChannelRoleEnum> roles)

      Value to remove from the array.

      If none of the specified roles are already present, an InvalidOperation error is returned.

      If all roles from the Channel are removed, an InvalidOperation error is returned.

      Parameters:
      roles - values to be set

    • of

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

    • of

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

    • copyDeep

      ChannelRemoveRolesAction copyDeep()
      Specified by:
      copyDeep in interface ChannelUpdateAction

    • deepCopy

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

    • builder

      static ChannelRemoveRolesActionBuilder builder()
      builder factory method for ChannelRemoveRolesAction
      Returns:
      builder

    • builder

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

    • withChannelRemoveRolesAction

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