Package com.commercetools.api.models.approval_rule

Interface ApprovalRuleSetKeyAction

All Superinterfaces:
ApprovalRuleUpdateAction
public interface ApprovalRuleSetKeyAction extends ApprovalRuleUpdateAction

Setting the key for an Approval Rule generates an ApprovalRuleKeySet Message.

Example to create an instance using the builder pattern 

     ApprovalRuleSetKeyAction approvalRuleSetKeyAction = ApprovalRuleSetKeyAction.builder()
             .build()

  • Field Details

  • Method Details

    • getKey

      String getKey()

      Value to set. Must be unique within a Business Unit. If empty, any existing value will be removed.

      Returns:
      key

    • setKey

      void setKey(String key)

      Value to set. Must be unique within a Business Unit. If empty, any existing value will be removed.

      Parameters:
      key - value to be set

    • of

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

    • of

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

    • copyDeep

      ApprovalRuleSetKeyAction copyDeep()
      Specified by:
      copyDeep in interface ApprovalRuleUpdateAction

    • deepCopy

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

    • builder

      static ApprovalRuleSetKeyActionBuilder builder()
      builder factory method for ApprovalRuleSetKeyAction
      Returns:
      builder

    • builder

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

    • withApprovalRuleSetKeyAction

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