com.sap.cloud.sdk.datamodel.odata.client.exception

Class ODataServiceError

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.client.exception.ODataServiceError

All Implemented Interfaces:

ODataServiceErrorDetails

public class ODataServiceError
extends Object
implements ODataServiceErrorDetails

OData error to serve the standard specification.

Constructor Summary

Constructors

Constructor and Description
ODataServiceError(String oDataCode, String oDataMessage, String target)
ODataServiceError(String oDataCode, String oDataMessage, String target, List<ODataServiceErrorDetails> details, Map<String,Object> innerError)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static ODataServiceError	fromResultObject(ResultObject resultObject, ODataProtocol protocol) SDK internal method to construct an OData error from a ResultObject.
List<ODataServiceErrorDetails>	getDetails() A list of all contained nested ODataServiceErrors.
Map<String,Object>	getInnerError() The innererror field of the response as a key-value map.
String	getODataCode() Language independent OData error response code.
String	getODataMessage() Language dependent OData error message.
io.vavr.control.Option<String>	getTarget() Optional OData service specific hint for origin of the error.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ODataServiceError

public ODataServiceError(@Nonnull
                         String oDataCode,
                         @Nonnull
                         String oDataMessage,
                         @Nullable
                         String target)

ODataServiceError

public ODataServiceError(@Nonnull
                         String oDataCode,
                         @Nonnull
                         String oDataMessage,
                         @Nullable
                         String target,
                         @Nullable
                         List<ODataServiceErrorDetails> details,
                         @Nullable
                         Map<String,Object> innerError)

Method Detail

getDetails

@Nonnull
public List<ODataServiceErrorDetails> getDetails()

A list of all contained nested ODataServiceErrors. If none were found in the response this list is empty. In case of OData V2 this corresponds to the errordetails field of innererror.

Returns:

A potentially empty List of error details.

See Also:

getInnerError()

getInnerError

@Nonnull
public Map<String,Object> getInnerError()

The innererror field of the response as a key-value map. If this field was not present on the response this map will be empty. In case of OData V2 the nested field errordetails is available separately via getDetails().

Returns:

A potentially empty Map containing the contents of the innererror field.

See Also:

getDetails()

fromResultObject

@Beta
 @Nonnull
public static ODataServiceError fromResultObject(@Nonnull
                                                                 ResultObject resultObject,
                                                                 @Nonnull
                                                                 ODataProtocol protocol)
                                                          throws UnsupportedOperationException

SDK internal method to construct an OData error from a ResultObject.

Parameters:

resultObject - The ResultObject that should be parsed.

protocol - The OData protocol version that should be assumed.

Returns:

A new ODataServiceError.

Throws:

UnsupportedOperationException - if parsing the result object failed.

getTarget

@Nonnull
public io.vavr.control.Option<String> getTarget()

Description copied from interface: ODataServiceErrorDetails

Optional OData service specific hint for origin of the error.

Specified by:

getTarget in interface ODataServiceErrorDetails

Returns:

An optional target.

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(@Nullable
                           Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

getODataCode

@Nonnull
public String getODataCode()

Description copied from interface: ODataServiceErrorDetails

Language independent OData error response code.

Specified by:

getODataCode in interface ODataServiceErrorDetails

Returns:

The OData error code.

getODataMessage

@Nonnull
public String getODataMessage()

Description copied from interface: ODataServiceErrorDetails

Language dependent OData error message. The language used is reflected by the "Content-Language" header in the HTTP response.

Specified by:

getODataMessage in interface ODataServiceErrorDetails

Returns:

The OData error message.