Package com.commercetools.api.models.agent

Interface AgentOutOfScopeError

All Superinterfaces:
ErrorObject
public interface AgentOutOfScopeError extends ErrorObject

Returned by a /responses request when the input does not contain enough information to create a Cart or a Quote Request: no products, no customer email address, and no shipping country could be determined.

Example to create an instance using the builder pattern 

     AgentOutOfScopeError agentOutOfScopeError = AgentOutOfScopeError.builder()
             .message("{message}")
             .build()

  • Field Details

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()
      Description copied from interface: ErrorObject

      Error identifier.

      Specified by:
      getCode in interface ErrorObject
      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      Plain text description of the error.

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • setMessage

      void setMessage(String message)

      Plain text description of the error.

      Specified by:
      setMessage in interface ErrorObject
      Parameters:
      message - value to be set

    • of

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

    • of

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

    • copyDeep

      AgentOutOfScopeError copyDeep()
      Specified by:
      copyDeep in interface ErrorObject

    • deepCopy

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

    • builder

      static AgentOutOfScopeErrorBuilder builder()
      builder factory method for AgentOutOfScopeError
      Returns:
      builder

    • builder

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

    • withAgentOutOfScopeError

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