Interface ErrorObject
- All Known Subinterfaces:
AgentBusinessUnitAmbiguousError,AgentBusinessUnitLimitExceededError,AgentBusinessUnitUnresolvedError,AgentExtractionFailedError,AgentFeatureDisabledError,AgentMissingCountryError,AgentMissingCustomerEmailError,AgentMissingEntityTypeError,AgentNoLineItemsExtractedError,AgentOutOfScopeError,AgentProductSearchNotEnabledError,AgentProductsNotFoundError,AgentQuoteRequestCreationFailedError,AgentStoreAmbiguousError,AgentStoreDistributionChannelsUnsupportedError,AgentStoreUnresolvedError,AnonymousIdAlreadyInUseError,AssociateMissingPermissionError,AttributeDefinitionAlreadyExistsError,AttributeDefinitionTypeConflictError,AttributeNameDoesNotExistError,BadGatewayError,BulkOperationMaxItemsExceededError,ConcurrentModificationError,ContentTooLargeError,CountryNotConfiguredInStoreError,DiscountCodeNonApplicableError,DuplicateAttributeValueError,DuplicateAttributeValuesError,DuplicateEnumValuesError,DuplicateFieldError,DuplicateFieldWithConflictingResourceError,DuplicatePriceKeyError,DuplicatePriceScopeError,DuplicateStandalonePriceScopeError,DuplicateVariantValuesError,EditPreviewFailedError,EnumKeyAlreadyExistsError,EnumKeyDoesNotExistError,EnumValueIsUsedError,EnumValuesMustMatchError,ExactLockConflictError,ExpiredCustomerEmailTokenError,ExpiredCustomerPasswordTokenError,ExtensionBadResponseError,ExtensionChainTooDeepError,ExtensionChainTooWideError,ExtensionCircularDependencyError,ExtensionDependencyExistsError,ExtensionNoResponseError,ExtensionPredicateEvaluationFailedError,ExtensionUpdateActionsFailedError,ExternalOAuthFailedError,FeatureRemovedError,GeneralError,InsufficientScopeError,InternalConstraintViolatedError,InvalidCredentialsError,InvalidCurrentPasswordError,InvalidFieldError,InvalidInputError,InvalidItemShippingDetailsError,InvalidJsonInputError,InvalidOperationError,InvalidSubjectError,InvalidTokenError,LanguageUsedInStoresError,LineItemQuantityAboveLimitError,LineItemQuantityBelowLimitError,LockedFieldError,MatchingPriceNotFoundError,MaxCartDiscountsReachedError,MaxDiscountGroupsReachedError,MaxResourceLimitExceededError,MaxStoreReferencesReachedError,MissingRoleOnChannelError,MissingTaxRateForCountryError,MoneyOverflowError,NoMatchingProductDiscountFoundError,ObjectNotFoundError,OutOfStockError,OverCapacityError,OverlappingPriceValidityError,OverlappingStandalonePriceValidityError,PendingOperationError,PriceChangedError,ProductAssignmentMissingError,ProductPresentWithDifferentVariantSelectionError,ProjectNotConfiguredForLanguagesError,QueryComplexityLimitExceededError,QueryTimedOutError,RecurringOrderFailureError,ReferencedResourceNotFoundError,ReferenceExistsError,RequiredFieldError,ResourceNotFoundError,ResourceSizeLimitExceededError,SearchDeactivatedError,SearchExecutionFailureError,SearchFacetPathNotFoundError,SearchIndexingInProgressError,SearchNotReadyError,SemanticErrorError,ShippingMethodDoesNotMatchCartError,StoreCartDiscountsLimitReachedError,SyntaxErrorError,UnauthorizedError,ValidityLockConflictError
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.businessUnitAmbiguousBuilder()
message("{message}")
.build()
-
Method Summary
Modifier and TypeMethodDescriptionbuilder for anonymousIdAlreadyInUse subtypebuilder for associateMissingPermission subtypebuilder for attributeDefinitionAlreadyExists subtypebuilder for attributeDefinitionTypeConflict subtypebuilder for attributeNameDoesNotExist subtypestatic BadGatewayErrorBuilderbuilder for badGateway subtypebuilder for bulkOperationMaxItemsExceeded subtypebuilder for businessUnitAmbiguous subtypebuilder for businessUnitLimitExceeded subtypebuilder for businessUnitUnresolved subtypebuilder for concurrentModification subtypestatic ContentTooLargeErrorBuilderbuilder for contentTooLarge subtypecopyDeep()builder for countryNotConfiguredInStore subtypestatic ErrorObjectdeepCopy(ErrorObject template) factory method to create a deep copy of ErrorObjectbuilder for discountCodeNonApplicable subtypebuilder for duplicateAttributeValue subtypebuilder for duplicateAttributeValues subtypebuilder for duplicateEnumValues subtypestatic DuplicateFieldErrorBuilderbuilder for duplicateField subtypebuilder for duplicateFieldWithConflictingResource subtypebuilder for duplicatePriceKey subtypebuilder for duplicatePriceScope subtypebuilder for duplicateStandalonePriceScope subtypebuilder for duplicateVariantValues subtypebuilder for editPreviewFailed subtypebuilder for enumKeyAlreadyExists subtypebuilder for enumKeyDoesNotExist subtypestatic EnumValueIsUsedErrorBuilderbuilder for enumValueIsUsed subtypebuilder for enumValuesMustMatch subtypebuilder for exactLockConflict subtypebuilder for expiredCustomerEmailToken subtypebuilder for expiredCustomerPasswordToken subtypebuilder for extensionBadResponse subtypebuilder for extensionChainTooDeep subtypebuilder for extensionChainTooWide subtypebuilder for extensionCircularDependency subtypebuilder for extensionDependencyExists subtypebuilder for extensionNoResponse subtypebuilder for extensionPredicateEvaluationFailed subtypebuilder for extensionUpdateActionsFailed subtypebuilder for externalOAuthFailed subtypebuilder for extractionFailed subtypebuilder for featureDisabled subtypestatic FeatureRemovedErrorBuilderbuilder for featureRemoved subtypestatic GeneralErrorBuilderbuilder for general subtype@NotNull StringgetCode()Error identifier.@NotNull StringPlain text description of the cause of the error.builder for insufficientScope subtypebuilder for internalConstraintViolated subtypebuilder for invalidCredentials subtypebuilder for invalidCurrentPassword subtypestatic InvalidFieldErrorBuilderbuilder for invalidField subtypestatic InvalidInputErrorBuilderbuilder for invalidInput subtypebuilder for invalidItemShippingDetails subtypestatic InvalidJsonInputErrorBuilderbuilder for invalidJsonInput subtypestatic InvalidOperationErrorBuilderbuilder for invalidOperation subtypestatic InvalidSubjectErrorBuilderbuilder for invalidSubject subtypestatic InvalidTokenErrorBuilderbuilder for invalidToken subtypebuilder for languageUsedInStores subtypebuilder for lineItemQuantityAboveLimit subtypebuilder for lineItemQuantityBelowLimit subtypestatic LockedFieldErrorBuilderbuilder for lockedField subtypebuilder for matchingPriceNotFound subtypebuilder for maxCartDiscountsReached subtypebuilder for maxDiscountGroupsReached subtypebuilder for maxResourceLimitExceeded subtypebuilder for maxStoreReferencesReached subtypebuilder for missingCountry subtypebuilder for missingCustomerEmail subtypebuilder for missingEntityType subtypebuilder for missingRoleOnChannel subtypebuilder for missingTaxRateForCountry subtypestatic MoneyOverflowErrorBuilderbuilder for moneyOverflow subtypebuilder for noLineItemsExtracted subtypebuilder for noMatchingProductDiscountFound subtypestatic ObjectNotFoundErrorBuilderbuilder for objectNotFound subtypestatic AgentOutOfScopeErrorBuilderbuilder for outOfScope subtypestatic OutOfStockErrorBuilderbuilder for outOfStock subtypestatic OverCapacityErrorBuilderbuilder for overCapacity subtypebuilder for overlappingPriceValidity subtypebuilder for overlappingStandalonePriceValidity subtypestatic PendingOperationErrorBuilderbuilder for pendingOperation subtypestatic PriceChangedErrorBuilderbuilder for priceChanged subtypebuilder for productAssignmentMissing subtypebuilder for productPresentWithDifferentVariantSelection subtypebuilder for productSearchNotEnabled subtypebuilder for productsNotFound subtypebuilder for projectNotConfiguredForLanguages subtypebuilder for queryComplexityLimitExceeded subtypestatic QueryTimedOutErrorBuilderbuilder for queryTimedOut subtypebuilder for quoteRequestCreationFailed subtypebuilder for recurringOrderFailure subtypebuilder for referencedResourceNotFound subtypestatic ReferenceExistsErrorBuilderbuilder for referenceExists subtypestatic RequiredFieldErrorBuilderbuilder for requiredField subtypestatic ResourceNotFoundErrorBuilderbuilder for resourceNotFound subtypebuilder for resourceSizeLimitExceeded subtypebuilder for searchDeactivated subtypebuilder for searchExecutionFailure subtypebuilder for searchFacetPathNotFound subtypebuilder for searchIndexingInProgress subtypestatic SearchNotReadyErrorBuilderbuilder for searchNotReady subtypestatic SemanticErrorErrorBuilderbuilder for semanticError subtypevoidsetMessage(String message) Plain text description of the cause of the error.voidError-specific additional fields.builder for shippingMethodDoesNotMatchCart subtypebuilder for storeAmbiguous subtypebuilder for storeCartDiscountsLimitReached subtypebuilder for storeDistributionChannelsUnsupported subtypebuilder for storeUnresolved subtypestatic SyntaxErrorErrorBuilderbuilder for syntaxError subtypestatic tools.jackson.core.type.TypeReference<ErrorObject>gives a TypeReference for usage with Jackson DataBindstatic UnauthorizedErrorBuilderbuilder for unauthorized subtypebuilder for validityLockConflict subtypevalues()Error-specific additional fields.default <T> TwithErrorObject(Function<ErrorObject, T> helper) accessor map function
-
Method Details
-
getCode
Error identifier.
- Returns:
- code
-
getMessage
Plain text description of the cause of the error.
- Returns:
- message
-
values
Error-specific additional fields.
- Returns:
- map of the pattern property values
-
setMessage
Plain text description of the cause of the error.
- Parameters:
message- value to be set
-
setValue
Error-specific additional fields.
- Parameters:
key- property namevalue- property value
-
copyDeep
ErrorObject copyDeep() -
deepCopy
factory method to create a deep copy of ErrorObject- Parameters:
template- instance to be copied- Returns:
- copy instance
-
businessUnitAmbiguousBuilder
builder for businessUnitAmbiguous subtype- Returns:
- builder
-
businessUnitLimitExceededBuilder
builder for businessUnitLimitExceeded subtype- Returns:
- builder
-
businessUnitUnresolvedBuilder
builder for businessUnitUnresolved subtype- Returns:
- builder
-
extractionFailedBuilder
builder for extractionFailed subtype- Returns:
- builder
-
featureDisabledBuilder
builder for featureDisabled subtype- Returns:
- builder
-
missingCountryBuilder
builder for missingCountry subtype- Returns:
- builder
-
missingCustomerEmailBuilder
builder for missingCustomerEmail subtype- Returns:
- builder
-
missingEntityTypeBuilder
builder for missingEntityType subtype- Returns:
- builder
-
noLineItemsExtractedBuilder
builder for noLineItemsExtracted subtype- Returns:
- builder
-
outOfScopeBuilder
builder for outOfScope subtype- Returns:
- builder
-
productSearchNotEnabledBuilder
builder for productSearchNotEnabled subtype- Returns:
- builder
-
productsNotFoundBuilder
builder for productsNotFound subtype- Returns:
- builder
-
quoteRequestCreationFailedBuilder
builder for quoteRequestCreationFailed subtype- Returns:
- builder
-
storeAmbiguousBuilder
builder for storeAmbiguous subtype- Returns:
- builder
-
storeDistributionChannelsUnsupportedBuilder
static AgentStoreDistributionChannelsUnsupportedErrorBuilder storeDistributionChannelsUnsupportedBuilder()builder for storeDistributionChannelsUnsupported subtype- Returns:
- builder
-
storeUnresolvedBuilder
builder for storeUnresolved subtype- Returns:
- builder
-
anonymousIdAlreadyInUseBuilder
builder for anonymousIdAlreadyInUse subtype- Returns:
- builder
-
associateMissingPermissionBuilder
builder for associateMissingPermission subtype- Returns:
- builder
-
attributeDefinitionAlreadyExistsBuilder
builder for attributeDefinitionAlreadyExists subtype- Returns:
- builder
-
attributeDefinitionTypeConflictBuilder
builder for attributeDefinitionTypeConflict subtype- Returns:
- builder
-
attributeNameDoesNotExistBuilder
builder for attributeNameDoesNotExist subtype- Returns:
- builder
-
badGatewayBuilder
builder for badGateway subtype- Returns:
- builder
-
bulkOperationMaxItemsExceededBuilder
builder for bulkOperationMaxItemsExceeded subtype- Returns:
- builder
-
concurrentModificationBuilder
builder for concurrentModification subtype- Returns:
- builder
-
contentTooLargeBuilder
builder for contentTooLarge subtype- Returns:
- builder
-
countryNotConfiguredInStoreBuilder
builder for countryNotConfiguredInStore subtype- Returns:
- builder
-
discountCodeNonApplicableBuilder
builder for discountCodeNonApplicable subtype- Returns:
- builder
-
duplicateAttributeValueBuilder
builder for duplicateAttributeValue subtype- Returns:
- builder
-
duplicateAttributeValuesBuilder
builder for duplicateAttributeValues subtype- Returns:
- builder
-
duplicateEnumValuesBuilder
builder for duplicateEnumValues subtype- Returns:
- builder
-
duplicateFieldBuilder
builder for duplicateField subtype- Returns:
- builder
-
duplicateFieldWithConflictingResourceBuilder
static DuplicateFieldWithConflictingResourceErrorBuilder duplicateFieldWithConflictingResourceBuilder()builder for duplicateFieldWithConflictingResource subtype- Returns:
- builder
-
duplicatePriceKeyBuilder
builder for duplicatePriceKey subtype- Returns:
- builder
-
duplicatePriceScopeBuilder
builder for duplicatePriceScope subtype- Returns:
- builder
-
duplicateStandalonePriceScopeBuilder
builder for duplicateStandalonePriceScope subtype- Returns:
- builder
-
duplicateVariantValuesBuilder
builder for duplicateVariantValues subtype- Returns:
- builder
-
editPreviewFailedBuilder
builder for editPreviewFailed subtype- Returns:
- builder
-
enumKeyAlreadyExistsBuilder
builder for enumKeyAlreadyExists subtype- Returns:
- builder
-
enumKeyDoesNotExistBuilder
builder for enumKeyDoesNotExist subtype- Returns:
- builder
-
enumValueIsUsedBuilder
builder for enumValueIsUsed subtype- Returns:
- builder
-
enumValuesMustMatchBuilder
builder for enumValuesMustMatch subtype- Returns:
- builder
-
exactLockConflictBuilder
builder for exactLockConflict subtype- Returns:
- builder
-
expiredCustomerEmailTokenBuilder
builder for expiredCustomerEmailToken subtype- Returns:
- builder
-
expiredCustomerPasswordTokenBuilder
builder for expiredCustomerPasswordToken subtype- Returns:
- builder
-
extensionBadResponseBuilder
builder for extensionBadResponse subtype- Returns:
- builder
-
extensionChainTooDeepBuilder
builder for extensionChainTooDeep subtype- Returns:
- builder
-
extensionChainTooWideBuilder
builder for extensionChainTooWide subtype- Returns:
- builder
-
extensionCircularDependencyBuilder
builder for extensionCircularDependency subtype- Returns:
- builder
-
extensionDependencyExistsBuilder
builder for extensionDependencyExists subtype- Returns:
- builder
-
extensionNoResponseBuilder
builder for extensionNoResponse subtype- Returns:
- builder
-
extensionPredicateEvaluationFailedBuilder
builder for extensionPredicateEvaluationFailed subtype- Returns:
- builder
-
extensionUpdateActionsFailedBuilder
builder for extensionUpdateActionsFailed subtype- Returns:
- builder
-
externalOAuthFailedBuilder
builder for externalOAuthFailed subtype- Returns:
- builder
-
featureRemovedBuilder
builder for featureRemoved subtype- Returns:
- builder
-
generalBuilder
builder for general subtype- Returns:
- builder
-
insufficientScopeBuilder
builder for insufficientScope subtype- Returns:
- builder
-
internalConstraintViolatedBuilder
builder for internalConstraintViolated subtype- Returns:
- builder
-
invalidCredentialsBuilder
builder for invalidCredentials subtype- Returns:
- builder
-
invalidCurrentPasswordBuilder
builder for invalidCurrentPassword subtype- Returns:
- builder
-
invalidFieldBuilder
builder for invalidField subtype- Returns:
- builder
-
invalidInputBuilder
builder for invalidInput subtype- Returns:
- builder
-
invalidItemShippingDetailsBuilder
builder for invalidItemShippingDetails subtype- Returns:
- builder
-
invalidJsonInputBuilder
builder for invalidJsonInput subtype- Returns:
- builder
-
invalidOperationBuilder
builder for invalidOperation subtype- Returns:
- builder
-
invalidSubjectBuilder
builder for invalidSubject subtype- Returns:
- builder
-
invalidTokenBuilder
builder for invalidToken subtype- Returns:
- builder
-
languageUsedInStoresBuilder
builder for languageUsedInStores subtype- Returns:
- builder
-
lineItemQuantityAboveLimitBuilder
builder for lineItemQuantityAboveLimit subtype- Returns:
- builder
-
lineItemQuantityBelowLimitBuilder
builder for lineItemQuantityBelowLimit subtype- Returns:
- builder
-
lockedFieldBuilder
builder for lockedField subtype- Returns:
- builder
-
matchingPriceNotFoundBuilder
builder for matchingPriceNotFound subtype- Returns:
- builder
-
maxCartDiscountsReachedBuilder
builder for maxCartDiscountsReached subtype- Returns:
- builder
-
maxDiscountGroupsReachedBuilder
builder for maxDiscountGroupsReached subtype- Returns:
- builder
-
maxResourceLimitExceededBuilder
builder for maxResourceLimitExceeded subtype- Returns:
- builder
-
maxStoreReferencesReachedBuilder
builder for maxStoreReferencesReached subtype- Returns:
- builder
-
missingRoleOnChannelBuilder
builder for missingRoleOnChannel subtype- Returns:
- builder
-
missingTaxRateForCountryBuilder
builder for missingTaxRateForCountry subtype- Returns:
- builder
-
moneyOverflowBuilder
builder for moneyOverflow subtype- Returns:
- builder
-
noMatchingProductDiscountFoundBuilder
builder for noMatchingProductDiscountFound subtype- Returns:
- builder
-
objectNotFoundBuilder
builder for objectNotFound subtype- Returns:
- builder
-
outOfStockBuilder
builder for outOfStock subtype- Returns:
- builder
-
overCapacityBuilder
builder for overCapacity subtype- Returns:
- builder
-
overlappingPriceValidityBuilder
builder for overlappingPriceValidity subtype- Returns:
- builder
-
overlappingStandalonePriceValidityBuilder
builder for overlappingStandalonePriceValidity subtype- Returns:
- builder
-
pendingOperationBuilder
builder for pendingOperation subtype- Returns:
- builder
-
priceChangedBuilder
builder for priceChanged subtype- Returns:
- builder
-
productAssignmentMissingBuilder
builder for productAssignmentMissing subtype- Returns:
- builder
-
productPresentWithDifferentVariantSelectionBuilder
static ProductPresentWithDifferentVariantSelectionErrorBuilder productPresentWithDifferentVariantSelectionBuilder()builder for productPresentWithDifferentVariantSelection subtype- Returns:
- builder
-
projectNotConfiguredForLanguagesBuilder
builder for projectNotConfiguredForLanguages subtype- Returns:
- builder
-
queryComplexityLimitExceededBuilder
builder for queryComplexityLimitExceeded subtype- Returns:
- builder
-
queryTimedOutBuilder
builder for queryTimedOut subtype- Returns:
- builder
-
recurringOrderFailureBuilder
builder for recurringOrderFailure subtype- Returns:
- builder
-
referenceExistsBuilder
builder for referenceExists subtype- Returns:
- builder
-
referencedResourceNotFoundBuilder
builder for referencedResourceNotFound subtype- Returns:
- builder
-
requiredFieldBuilder
builder for requiredField subtype- Returns:
- builder
-
resourceNotFoundBuilder
builder for resourceNotFound subtype- Returns:
- builder
-
resourceSizeLimitExceededBuilder
builder for resourceSizeLimitExceeded subtype- Returns:
- builder
-
searchDeactivatedBuilder
builder for searchDeactivated subtype- Returns:
- builder
-
searchExecutionFailureBuilder
builder for searchExecutionFailure subtype- Returns:
- builder
-
searchFacetPathNotFoundBuilder
builder for searchFacetPathNotFound subtype- Returns:
- builder
-
searchIndexingInProgressBuilder
builder for searchIndexingInProgress subtype- Returns:
- builder
-
searchNotReadyBuilder
builder for searchNotReady subtype- Returns:
- builder
-
semanticErrorBuilder
builder for semanticError subtype- Returns:
- builder
-
shippingMethodDoesNotMatchCartBuilder
builder for shippingMethodDoesNotMatchCart subtype- Returns:
- builder
-
storeCartDiscountsLimitReachedBuilder
builder for storeCartDiscountsLimitReached subtype- Returns:
- builder
-
syntaxErrorBuilder
builder for syntaxError subtype- Returns:
- builder
-
unauthorizedBuilder
builder for unauthorized subtype- Returns:
- builder
-
validityLockConflictBuilder
builder for validityLockConflict subtype- Returns:
- builder
-
withErrorObject
accessor map function- Type Parameters:
T- mapped type- Parameters:
helper- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-