Package com.commercetools.api.models.state

Interface StateSetTransitionsAction

All Superinterfaces:
ResourceUpdateAction<StateUpdateAction>, StateUpdateAction
All Known Implementing Classes:
StateSetTransitionsActionImpl
public interface StateSetTransitionsAction extends StateUpdateAction
StateSetTransitionsAction
Example to create an instance using the builder pattern 

     StateSetTransitionsAction stateSetTransitionsAction = StateSetTransitionsAction.builder()
             .build()

  • Field Details

  • Method Details

    • getTransitions

      @Valid @Valid List<StateResourceIdentifier> getTransitions()

      Value to set. If empty, any existing value will be removed.

      Possible transformations of the current State to other States of the same type (for example, Initial -> Shipped). When performing a transitionState update action and transitions is set, the currently referenced State must have a transition to the new State.

      If transitions is an empty list, it means the current State is a final State and no further transitions are allowed. If transitions is not set, the validation is turned off.

      When performing a transitionState update action, any other State of the same type can be transitioned to.

      Returns:
      transitions

    • setTransitions

      void setTransitions(StateResourceIdentifier... transitions)

      Value to set. If empty, any existing value will be removed.

      Possible transformations of the current State to other States of the same type (for example, Initial -> Shipped). When performing a transitionState update action and transitions is set, the currently referenced State must have a transition to the new State.

      If transitions is an empty list, it means the current State is a final State and no further transitions are allowed. If transitions is not set, the validation is turned off.

      When performing a transitionState update action, any other State of the same type can be transitioned to.

      Parameters:
      transitions - values to be set

    • setTransitions

      void setTransitions(List<StateResourceIdentifier> transitions)

      Value to set. If empty, any existing value will be removed.

      Possible transformations of the current State to other States of the same type (for example, Initial -> Shipped). When performing a transitionState update action and transitions is set, the currently referenced State must have a transition to the new State.

      If transitions is an empty list, it means the current State is a final State and no further transitions are allowed. If transitions is not set, the validation is turned off.

      When performing a transitionState update action, any other State of the same type can be transitioned to.

      Parameters:
      transitions - values to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static StateSetTransitionsActionBuilder builder()
      builder factory method for StateSetTransitionsAction
      Returns:
      builder

    • builder

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

    • withStateSetTransitionsAction

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