Class Error
java.lang.Object
de.hybris.platform.billingaccounttmfwebservices.v1.dto.Error
@Validated
@Generated(value="de.hybris.platform.billingaccounttmfwebservices.swagger.BaBillingAccountCodegen",
date="2022-10-21T20:35:18.164Z")
public class Error
extends Object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionatbaseType(String atbaseType) atschemaLocation(String atschemaLocation) booleanWhen sub-classing, this defines the super-class.A URI to a JSON-Schema file that defines additional attributes and relationshipsWhen sub-classing, this defines the sub-class entity name.@NotNull StringgetCode()Application relevant detail, defined in the API or a common list.@NotNull StringMore details and corrective actions related to the error which can be shown to a client user.Explanation of the reason for the error which can be shown to a client user.URI of documentation describing the error.HTTP Error code extensioninthashCode()referenceError(String referenceError) voidsetAtbaseType(String atbaseType) voidsetAtschemaLocation(String atschemaLocation) voidvoidvoidsetMessage(String message) voidvoidsetReferenceError(String referenceError) voidtoString()
-
Constructor Details
-
Error
public Error()
-
-
Method Details
-
code
-
getCode
Application relevant detail, defined in the API or a common list.- Returns:
- code
-
setCode
-
reason
-
getReason
Explanation of the reason for the error which can be shown to a client user.- Returns:
- reason
-
setReason
-
message
-
getMessage
More details and corrective actions related to the error which can be shown to a client user.- Returns:
- message
-
setMessage
-
status
-
getStatus
HTTP Error code extension- Returns:
- status
-
setStatus
-
referenceError
-
getReferenceError
URI of documentation describing the error.- Returns:
- referenceError
-
setReferenceError
-
atbaseType
-
getAtbaseType
When sub-classing, this defines the super-class.- Returns:
- atbaseType
-
setAtbaseType
-
atschemaLocation
-
getAtschemaLocation
A URI to a JSON-Schema file that defines additional attributes and relationships- Returns:
- atschemaLocation
-
setAtschemaLocation
-
attype
-
getAttype
When sub-classing, this defines the sub-class entity name.- Returns:
- attype
-
setAttype
-
equals
-
hashCode
public int hashCode() -
toString
-