Package com.commercetools.api.models.error

Interface ErrorObject

All Known Subinterfaces:
AnonymousIdAlreadyInUseError, AssociateMissingPermissionError, AttributeDefinitionAlreadyExistsError, AttributeDefinitionTypeConflictError, AttributeNameDoesNotExistError, BadGatewayError, ConcurrentModificationError, ContentTooLargeError, CountryNotConfiguredInStoreError, DiscountCodeNonApplicableError, DuplicateAttributeValueError, DuplicateAttributeValuesError, DuplicateEnumValuesError, DuplicateFieldError, DuplicateFieldWithConflictingResourceError, DuplicatePriceKeyError, DuplicatePriceScopeError, DuplicateStandalonePriceScopeError, DuplicateVariantValuesError, EditPreviewFailedError, EnumKeyAlreadyExistsError, EnumKeyDoesNotExistError, EnumValueIsUsedError, EnumValuesMustMatchError, ExtensionBadResponseError, ExtensionNoResponseError, ExtensionPredicateEvaluationFailedError, ExtensionUpdateActionsFailedError, ExternalOAuthFailedError, FeatureRemovedError, GeneralError, InsufficientScopeError, InternalConstraintViolatedError, InvalidCredentialsError, InvalidCurrentPasswordError, InvalidFieldError, InvalidInputError, InvalidItemShippingDetailsError, InvalidJsonInputError, InvalidOperationError, InvalidSubjectError, InvalidTokenError, LanguageUsedInStoresError, LockedFieldError, MatchingPriceNotFoundError, MaxCartDiscountsReachedError, MaxResourceLimitExceededError, MaxStoreReferencesReachedError, MissingRoleOnChannelError, MissingTaxRateForCountryError, MoneyOverflowError, NoMatchingProductDiscountFoundError, ObjectNotFoundError, OutOfStockError, OverCapacityError, OverlappingStandalonePriceValidityError, PendingOperationError, PriceChangedError, ProductAssignmentMissingError, ProductPresentWithDifferentVariantSelectionError, ProjectNotConfiguredForLanguagesError, QueryComplexityLimitExceededError, QueryTimedOutError, ReferencedResourceNotFoundError, ReferenceExistsError, RequiredFieldError, ResourceNotFoundError, ResourceSizeLimitExceededError, SearchDeactivatedError, SearchExecutionFailureError, SearchFacetPathNotFoundError, SearchIndexingInProgressError, SearchNotReadyError, SemanticErrorError, ShippingMethodDoesNotMatchCartError, StoreCartDiscountsLimitReachedError, SyntaxErrorError
public interface ErrorObject

Represents a single error. Multiple errors may be included in an ErrorResponse.

Example to create a subtype instance using the builder pattern 

     ErrorObject errorObject = ErrorObject.anonymousIdAlreadyInUseBuilder()
             message("{message}")

             .build()

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()

      Error identifier.

      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      Plain text description of the cause of the error.

      Returns:
      message

    • values

      @NotNull @NotNull Map<String,Object> values()

      Error-specific additional fields.

      Returns:
      map of the pattern property values

    • setMessage

      void setMessage(String message)

      Plain text description of the cause of the error.

      Parameters:
      message - value to be set

    • setValue

      void setValue(String key, Object value)

      Error-specific additional fields.

      Parameters:
      key - property name
      value - property value

    • deepCopy

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

    • anonymousIdAlreadyInUseBuilder

      static AnonymousIdAlreadyInUseErrorBuilder anonymousIdAlreadyInUseBuilder()
      builder for anonymousIdAlreadyInUse subtype
      Returns:
      builder

    • associateMissingPermissionBuilder

      static AssociateMissingPermissionErrorBuilder associateMissingPermissionBuilder()
      builder for associateMissingPermission subtype
      Returns:
      builder

    • attributeDefinitionAlreadyExistsBuilder

      static AttributeDefinitionAlreadyExistsErrorBuilder attributeDefinitionAlreadyExistsBuilder()
      builder for attributeDefinitionAlreadyExists subtype
      Returns:
      builder

    • attributeDefinitionTypeConflictBuilder

      static AttributeDefinitionTypeConflictErrorBuilder attributeDefinitionTypeConflictBuilder()
      builder for attributeDefinitionTypeConflict subtype
      Returns:
      builder

    • attributeNameDoesNotExistBuilder

      static AttributeNameDoesNotExistErrorBuilder attributeNameDoesNotExistBuilder()
      builder for attributeNameDoesNotExist subtype
      Returns:
      builder

    • badGatewayBuilder

      static BadGatewayErrorBuilder badGatewayBuilder()
      builder for badGateway subtype
      Returns:
      builder

    • concurrentModificationBuilder

      static ConcurrentModificationErrorBuilder concurrentModificationBuilder()
      builder for concurrentModification subtype
      Returns:
      builder

    • contentTooLargeBuilder

      static ContentTooLargeErrorBuilder contentTooLargeBuilder()
      builder for contentTooLarge subtype
      Returns:
      builder

    • countryNotConfiguredInStoreBuilder

      static CountryNotConfiguredInStoreErrorBuilder countryNotConfiguredInStoreBuilder()
      builder for countryNotConfiguredInStore subtype
      Returns:
      builder

    • discountCodeNonApplicableBuilder

      static DiscountCodeNonApplicableErrorBuilder discountCodeNonApplicableBuilder()
      builder for discountCodeNonApplicable subtype
      Returns:
      builder

    • duplicateAttributeValueBuilder

      static DuplicateAttributeValueErrorBuilder duplicateAttributeValueBuilder()
      builder for duplicateAttributeValue subtype
      Returns:
      builder

    • duplicateAttributeValuesBuilder

      static DuplicateAttributeValuesErrorBuilder duplicateAttributeValuesBuilder()
      builder for duplicateAttributeValues subtype
      Returns:
      builder

    • duplicateEnumValuesBuilder

      static DuplicateEnumValuesErrorBuilder duplicateEnumValuesBuilder()
      builder for duplicateEnumValues subtype
      Returns:
      builder

    • duplicateFieldBuilder

      static DuplicateFieldErrorBuilder duplicateFieldBuilder()
      builder for duplicateField subtype
      Returns:
      builder

    • duplicateFieldWithConflictingResourceBuilder

      static DuplicateFieldWithConflictingResourceErrorBuilder duplicateFieldWithConflictingResourceBuilder()
      builder for duplicateFieldWithConflictingResource subtype
      Returns:
      builder

    • duplicatePriceKeyBuilder

      static DuplicatePriceKeyErrorBuilder duplicatePriceKeyBuilder()
      builder for duplicatePriceKey subtype
      Returns:
      builder

    • duplicatePriceScopeBuilder

      static DuplicatePriceScopeErrorBuilder duplicatePriceScopeBuilder()
      builder for duplicatePriceScope subtype
      Returns:
      builder

    • duplicateStandalonePriceScopeBuilder

      static DuplicateStandalonePriceScopeErrorBuilder duplicateStandalonePriceScopeBuilder()
      builder for duplicateStandalonePriceScope subtype
      Returns:
      builder

    • duplicateVariantValuesBuilder

      static DuplicateVariantValuesErrorBuilder duplicateVariantValuesBuilder()
      builder for duplicateVariantValues subtype
      Returns:
      builder

    • editPreviewFailedBuilder

      static EditPreviewFailedErrorBuilder editPreviewFailedBuilder()
      builder for editPreviewFailed subtype
      Returns:
      builder

    • enumKeyAlreadyExistsBuilder

      static EnumKeyAlreadyExistsErrorBuilder enumKeyAlreadyExistsBuilder()
      builder for enumKeyAlreadyExists subtype
      Returns:
      builder

    • enumKeyDoesNotExistBuilder

      static EnumKeyDoesNotExistErrorBuilder enumKeyDoesNotExistBuilder()
      builder for enumKeyDoesNotExist subtype
      Returns:
      builder

    • enumValueIsUsedBuilder

      static EnumValueIsUsedErrorBuilder enumValueIsUsedBuilder()
      builder for enumValueIsUsed subtype
      Returns:
      builder

    • enumValuesMustMatchBuilder

      static EnumValuesMustMatchErrorBuilder enumValuesMustMatchBuilder()
      builder for enumValuesMustMatch subtype
      Returns:
      builder

    • extensionBadResponseBuilder

      static ExtensionBadResponseErrorBuilder extensionBadResponseBuilder()
      builder for extensionBadResponse subtype
      Returns:
      builder

    • extensionNoResponseBuilder

      static ExtensionNoResponseErrorBuilder extensionNoResponseBuilder()
      builder for extensionNoResponse subtype
      Returns:
      builder

    • extensionPredicateEvaluationFailedBuilder

      static ExtensionPredicateEvaluationFailedErrorBuilder extensionPredicateEvaluationFailedBuilder()
      builder for extensionPredicateEvaluationFailed subtype
      Returns:
      builder

    • extensionUpdateActionsFailedBuilder

      static ExtensionUpdateActionsFailedErrorBuilder extensionUpdateActionsFailedBuilder()
      builder for extensionUpdateActionsFailed subtype
      Returns:
      builder

    • externalOAuthFailedBuilder

      static ExternalOAuthFailedErrorBuilder externalOAuthFailedBuilder()
      builder for externalOAuthFailed subtype
      Returns:
      builder

    • featureRemovedBuilder

      static FeatureRemovedErrorBuilder featureRemovedBuilder()
      builder for featureRemoved subtype
      Returns:
      builder

    • generalBuilder

      static GeneralErrorBuilder generalBuilder()
      builder for general subtype
      Returns:
      builder

    • insufficientScopeBuilder

      static InsufficientScopeErrorBuilder insufficientScopeBuilder()
      builder for insufficientScope subtype
      Returns:
      builder

    • internalConstraintViolatedBuilder

      static InternalConstraintViolatedErrorBuilder internalConstraintViolatedBuilder()
      builder for internalConstraintViolated subtype
      Returns:
      builder

    • invalidCredentialsBuilder

      static InvalidCredentialsErrorBuilder invalidCredentialsBuilder()
      builder for invalidCredentials subtype
      Returns:
      builder

    • invalidCurrentPasswordBuilder

      static InvalidCurrentPasswordErrorBuilder invalidCurrentPasswordBuilder()
      builder for invalidCurrentPassword subtype
      Returns:
      builder

    • invalidFieldBuilder

      static InvalidFieldErrorBuilder invalidFieldBuilder()
      builder for invalidField subtype
      Returns:
      builder

    • invalidInputBuilder

      static InvalidInputErrorBuilder invalidInputBuilder()
      builder for invalidInput subtype
      Returns:
      builder

    • invalidItemShippingDetailsBuilder

      static InvalidItemShippingDetailsErrorBuilder invalidItemShippingDetailsBuilder()
      builder for invalidItemShippingDetails subtype
      Returns:
      builder

    • invalidJsonInputBuilder

      static InvalidJsonInputErrorBuilder invalidJsonInputBuilder()
      builder for invalidJsonInput subtype
      Returns:
      builder

    • invalidOperationBuilder

      static InvalidOperationErrorBuilder invalidOperationBuilder()
      builder for invalidOperation subtype
      Returns:
      builder

    • invalidSubjectBuilder

      static InvalidSubjectErrorBuilder invalidSubjectBuilder()
      builder for invalidSubject subtype
      Returns:
      builder

    • invalidTokenBuilder

      static InvalidTokenErrorBuilder invalidTokenBuilder()
      builder for invalidToken subtype
      Returns:
      builder

    • languageUsedInStoresBuilder

      static LanguageUsedInStoresErrorBuilder languageUsedInStoresBuilder()
      builder for languageUsedInStores subtype
      Returns:
      builder

    • lockedFieldBuilder

      static LockedFieldErrorBuilder lockedFieldBuilder()
      builder for lockedField subtype
      Returns:
      builder

    • matchingPriceNotFoundBuilder

      static MatchingPriceNotFoundErrorBuilder matchingPriceNotFoundBuilder()
      builder for matchingPriceNotFound subtype
      Returns:
      builder

    • maxCartDiscountsReachedBuilder

      static MaxCartDiscountsReachedErrorBuilder maxCartDiscountsReachedBuilder()
      builder for maxCartDiscountsReached subtype
      Returns:
      builder

    • maxResourceLimitExceededBuilder

      static MaxResourceLimitExceededErrorBuilder maxResourceLimitExceededBuilder()
      builder for maxResourceLimitExceeded subtype
      Returns:
      builder

    • maxStoreReferencesReachedBuilder

      static MaxStoreReferencesReachedErrorBuilder maxStoreReferencesReachedBuilder()
      builder for maxStoreReferencesReached subtype
      Returns:
      builder

    • missingRoleOnChannelBuilder

      static MissingRoleOnChannelErrorBuilder missingRoleOnChannelBuilder()
      builder for missingRoleOnChannel subtype
      Returns:
      builder

    • missingTaxRateForCountryBuilder

      static MissingTaxRateForCountryErrorBuilder missingTaxRateForCountryBuilder()
      builder for missingTaxRateForCountry subtype
      Returns:
      builder

    • moneyOverflowBuilder

      static MoneyOverflowErrorBuilder moneyOverflowBuilder()
      builder for moneyOverflow subtype
      Returns:
      builder

    • noMatchingProductDiscountFoundBuilder

      static NoMatchingProductDiscountFoundErrorBuilder noMatchingProductDiscountFoundBuilder()
      builder for noMatchingProductDiscountFound subtype
      Returns:
      builder

    • objectNotFoundBuilder

      static ObjectNotFoundErrorBuilder objectNotFoundBuilder()
      builder for objectNotFound subtype
      Returns:
      builder

    • outOfStockBuilder

      static OutOfStockErrorBuilder outOfStockBuilder()
      builder for outOfStock subtype
      Returns:
      builder

    • overCapacityBuilder

      static OverCapacityErrorBuilder overCapacityBuilder()
      builder for overCapacity subtype
      Returns:
      builder

    • overlappingStandalonePriceValidityBuilder

      static OverlappingStandalonePriceValidityErrorBuilder overlappingStandalonePriceValidityBuilder()
      builder for overlappingStandalonePriceValidity subtype
      Returns:
      builder

    • pendingOperationBuilder

      static PendingOperationErrorBuilder pendingOperationBuilder()
      builder for pendingOperation subtype
      Returns:
      builder

    • priceChangedBuilder

      static PriceChangedErrorBuilder priceChangedBuilder()
      builder for priceChanged subtype
      Returns:
      builder

    • productAssignmentMissingBuilder

      static ProductAssignmentMissingErrorBuilder productAssignmentMissingBuilder()
      builder for productAssignmentMissing subtype
      Returns:
      builder

    • productPresentWithDifferentVariantSelectionBuilder

      static ProductPresentWithDifferentVariantSelectionErrorBuilder productPresentWithDifferentVariantSelectionBuilder()
      builder for productPresentWithDifferentVariantSelection subtype
      Returns:
      builder

    • projectNotConfiguredForLanguagesBuilder

      static ProjectNotConfiguredForLanguagesErrorBuilder projectNotConfiguredForLanguagesBuilder()
      builder for projectNotConfiguredForLanguages subtype
      Returns:
      builder

    • queryComplexityLimitExceededBuilder

      static QueryComplexityLimitExceededErrorBuilder queryComplexityLimitExceededBuilder()
      builder for queryComplexityLimitExceeded subtype
      Returns:
      builder

    • queryTimedOutBuilder

      static QueryTimedOutErrorBuilder queryTimedOutBuilder()
      builder for queryTimedOut subtype
      Returns:
      builder

    • referenceExistsBuilder

      static ReferenceExistsErrorBuilder referenceExistsBuilder()
      builder for referenceExists subtype
      Returns:
      builder

    • referencedResourceNotFoundBuilder

      static ReferencedResourceNotFoundErrorBuilder referencedResourceNotFoundBuilder()
      builder for referencedResourceNotFound subtype
      Returns:
      builder

    • requiredFieldBuilder

      static RequiredFieldErrorBuilder requiredFieldBuilder()
      builder for requiredField subtype
      Returns:
      builder

    • resourceNotFoundBuilder

      static ResourceNotFoundErrorBuilder resourceNotFoundBuilder()
      builder for resourceNotFound subtype
      Returns:
      builder

    • resourceSizeLimitExceededBuilder

      static ResourceSizeLimitExceededErrorBuilder resourceSizeLimitExceededBuilder()
      builder for resourceSizeLimitExceeded subtype
      Returns:
      builder

    • searchDeactivatedBuilder

      static SearchDeactivatedErrorBuilder searchDeactivatedBuilder()
      builder for searchDeactivated subtype
      Returns:
      builder

    • searchExecutionFailureBuilder

      static SearchExecutionFailureErrorBuilder searchExecutionFailureBuilder()
      builder for searchExecutionFailure subtype
      Returns:
      builder

    • searchFacetPathNotFoundBuilder

      static SearchFacetPathNotFoundErrorBuilder searchFacetPathNotFoundBuilder()
      builder for searchFacetPathNotFound subtype
      Returns:
      builder

    • searchIndexingInProgressBuilder

      static SearchIndexingInProgressErrorBuilder searchIndexingInProgressBuilder()
      builder for searchIndexingInProgress subtype
      Returns:
      builder

    • searchNotReadyBuilder

      static SearchNotReadyErrorBuilder searchNotReadyBuilder()
      builder for searchNotReady subtype
      Returns:
      builder

    • semanticErrorBuilder

      static SemanticErrorErrorBuilder semanticErrorBuilder()
      builder for semanticError subtype
      Returns:
      builder

    • shippingMethodDoesNotMatchCartBuilder

      static ShippingMethodDoesNotMatchCartErrorBuilder shippingMethodDoesNotMatchCartBuilder()
      builder for shippingMethodDoesNotMatchCart subtype
      Returns:
      builder

    • storeCartDiscountsLimitReachedBuilder

      static StoreCartDiscountsLimitReachedErrorBuilder storeCartDiscountsLimitReachedBuilder()
      builder for storeCartDiscountsLimitReached subtype
      Returns:
      builder

    • syntaxErrorBuilder

      static SyntaxErrorErrorBuilder syntaxErrorBuilder()
      builder for syntaxError subtype
      Returns:
      builder

    • withErrorObject

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