public class

OfflineODataErrorArchiveEntity

extends EntityValue
implements Parcelable
java.lang.Object
   ↳ com.sap.cloud.mobile.odata.DataValue
     ↳ com.sap.cloud.mobile.odata.StructureBase
       ↳ com.sap.cloud.mobile.odata.EntityValue
         ↳ com.sap.cloud.mobile.odata.offline.OfflineODataErrorArchiveEntity

Class Overview

A built-in Offline OData entity type which stores information about a modification request which failed during an upload operation.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static Property affectedEntity Metadata of the entity property affectedEntity.
public static Property code Metadata of the entity property code.
public static Property customTag Metadata of the entity property customTag.
public static Property dependentRequests Metadata of the entity property dependentRequests.
public static Property domain Metadata of the entity property domain.
public static Property httpStatusCode Metadata of the entity property httpStatusCode.
public static Property innerError Metadata of the entity property innerError.
public static Property message Metadata of the entity property message.
public static Property requestBody Metadata of the entity property requestBody.
public static Property requestEntity Metadata of the entity property requestEntity.
public static Property requestID Metadata of the entity property requestID.
public static Property requestMethod Metadata of the entity property requestMethod.
public static Property requestURL Metadata of the entity property requestURL.
[Expand]
Inherited Fields
From class com.sap.cloud.mobile.odata.DataValue
Public Methods
int describeContents()
Internal implementation.
EntityValue getAffectedEntity()

Return (nullable) The navigation property which allows navigating from the failed request to the primary entity.

String getCode()

Return (nullable) The error code returned in the OData error response from the OData backend.

String getCustomTag()

Return (nullable) A customized string that was used to tag the request.

List<OfflineODataRequest> getDependentRequests()

Return the navigation property which can be used to list requests that depend on this failed request.

String getDomain()

Return (nullable) Internal domain info.

Integer getHttpStatusCode()

Return (nullable) The HTTP status code returned from the OData backend.

String getInnerError()

Return (nullable) The inner error returned in the OData error response from the OData backend.

String getMessage()

Return (nullable) The error message returned in the OData error response from the OData backend.

String getRequestBody()

Return (nullable) The JSON body sent to the OData backend.

EntityValue getRequestEntity()

Return (nullable) The navigation property which can be used to directly read and directly modify the failed request in the request queue.

Long getRequestID()

Return (nullable) The request identifier.

String getRequestMethod()

Return (nullable) The HTTP method used for the request.

String getRequestURL()

Return (nullable) The request URL used when executing the request against the OData backend.

boolean isProxy()
void setAffectedEntity(EntityValue value)

Set the navigation property which allows navigating from the failed request to the primary entity.

void setCode(String value)

Set the error code returned in the OData error response from the OData backend.

void setCustomTag(String value)

Set a customized string that was used to tag the request.

void setDependentRequests(List<OfflineODataRequest> value)

Set the navigation property which can be used to list requests that depend on this failed request.

void setDomain(String value)

Set internal domain info.

void setHttpStatusCode(Integer value)

Set the HTTP status code returned from the OData backend.

void setInnerError(String value)

Set the inner error returned in the OData error response from the OData backend.

void setMessage(String value)

Set the error message returned in the OData error response from the OData backend.

void setRequestBody(String value)

Set the JSON body sent to the OData backend.

void setRequestEntity(EntityValue value)

Set the navigation property which can be used to directly read and directly modify the failed request in the request queue.

void setRequestID(Long value)

Set the request identifier.

void setRequestMethod(String value)

Set the HTTP method used for the request.

void setRequestURL(String value)

Set the request URL used when executing the request against the OData backend.

void writeToParcel(Parcel out, int flags)
Internal implementation.
[Expand]
Inherited Methods
From class com.sap.cloud.mobile.odata.EntityValue
From class com.sap.cloud.mobile.odata.StructureBase
From class com.sap.cloud.mobile.odata.DataValue
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static Property affectedEntity

Metadata of the entity property affectedEntity.

public static Property code

Metadata of the entity property code.

public static Property customTag

Metadata of the entity property customTag.

public static Property dependentRequests

Metadata of the entity property dependentRequests.

public static Property domain

Metadata of the entity property domain.

public static Property httpStatusCode

Metadata of the entity property httpStatusCode.

public static Property innerError

Metadata of the entity property innerError.

public static Property message

Metadata of the entity property message.

public static Property requestBody

Metadata of the entity property requestBody.

public static Property requestEntity

Metadata of the entity property requestEntity.

public static Property requestID

Metadata of the entity property requestID.

public static Property requestMethod

Metadata of the entity property requestMethod.

public static Property requestURL

Metadata of the entity property requestURL.

Public Methods

public int describeContents ()

Internal implementation. Ignore it.

public EntityValue getAffectedEntity ()

Return (nullable) The navigation property which allows navigating from the failed request to the primary entity. For example, if the failed request was a PATCH request on the entity Customers(101), this navigation property can be used to read the current state of Customers(101) in the Offline store.

Returns
  • (nullable) The navigation property which allows navigating from the failed request to the primary entity. For example, if the failed request was a PATCH request on the entity Customers(101), this navigation property can be used to read the current state of Customers(101) in the Offline store.

public String getCode ()

Return (nullable) The error code returned in the OData error response from the OData backend.

Returns
  • (nullable) The error code returned in the OData error response from the OData backend.

public String getCustomTag ()

Return (nullable) A customized string that was used to tag the request.

Returns
  • (nullable) A customized string that was used to tag the request.

public List<OfflineODataRequest> getDependentRequests ()

Return the navigation property which can be used to list requests that depend on this failed request.

Returns
  • The navigation property which can be used to list requests that depend on this failed request.

public String getDomain ()

Return (nullable) Internal domain info.

Returns
  • (nullable) Internal domain info.

public Integer getHttpStatusCode ()

Return (nullable) The HTTP status code returned from the OData backend.

Returns
  • (nullable) The HTTP status code returned from the OData backend.

public String getInnerError ()

Return (nullable) The inner error returned in the OData error response from the OData backend.

Returns
  • (nullable) The inner error returned in the OData error response from the OData backend.

public String getMessage ()

Return (nullable) The error message returned in the OData error response from the OData backend.

Returns
  • (nullable) The error message returned in the OData error response from the OData backend.

public String getRequestBody ()

Return (nullable) The JSON body sent to the OData backend.

Returns
  • (nullable) The JSON body sent to the OData backend.

public EntityValue getRequestEntity ()

Return (nullable) The navigation property which can be used to directly read and directly modify the failed request in the request queue. The actual entity type of the returned entity will be dependent on the type of request. For example, if the failed request was a PATCH request on the entity Customers(101), then the entity returned by this navigation property will have a Customer entity type. Note that this navigation property differs from AffectedEntity; AffectedEntity returns the CURRENT state of the entity in the Offline Store where as RequestEntity is an typed representation of the request in the request queue itself.

Returns
  • (nullable) The navigation property which can be used to directly read and directly modify the failed request in the request queue. The actual entity type of the returned entity will be dependent on the type of request. For example, if the failed request was a PATCH request on the entity Customers(101), then the entity returned by this navigation property will have a Customer entity type. Note that this navigation property differs from AffectedEntity; AffectedEntity returns the CURRENT state of the entity in the Offline Store where as RequestEntity is an typed representation of the request in the request queue itself.

public Long getRequestID ()

Return (nullable) The request identifier.

Returns
  • (nullable) The request identifier.

public String getRequestMethod ()

Return (nullable) The HTTP method used for the request.

Returns
  • (nullable) The HTTP method used for the request.

public String getRequestURL ()

Return (nullable) The request URL used when executing the request against the OData backend.

Returns
  • (nullable) The request URL used when executing the request against the OData backend.

public boolean isProxy ()

public void setAffectedEntity (EntityValue value)

Set the navigation property which allows navigating from the failed request to the primary entity. For example, if the failed request was a PATCH request on the entity Customers(101), this navigation property can be used to read the current state of Customers(101) in the Offline store.

Parameters
value The navigation property which allows navigating from the failed request to the primary entity. For example, if the failed request was a PATCH request on the entity Customers(101), this navigation property can be used to read the current state of Customers(101) in the Offline store.

public void setCode (String value)

Set the error code returned in the OData error response from the OData backend.

Parameters
value The error code returned in the OData error response from the OData backend.

public void setCustomTag (String value)

Set a customized string that was used to tag the request.

Parameters
value A customized string that was used to tag the request.

public void setDependentRequests (List<OfflineODataRequest> value)

Set the navigation property which can be used to list requests that depend on this failed request.

Parameters
value The navigation property which can be used to list requests that depend on this failed request.

public void setDomain (String value)

Set internal domain info.

Parameters
value Internal domain info.

public void setHttpStatusCode (Integer value)

Set the HTTP status code returned from the OData backend.

Parameters
value The HTTP status code returned from the OData backend.

public void setInnerError (String value)

Set the inner error returned in the OData error response from the OData backend.

Parameters
value The inner error returned in the OData error response from the OData backend.

public void setMessage (String value)

Set the error message returned in the OData error response from the OData backend.

Parameters
value The error message returned in the OData error response from the OData backend.

public void setRequestBody (String value)

Set the JSON body sent to the OData backend.

Parameters
value The JSON body sent to the OData backend.

public void setRequestEntity (EntityValue value)

Set the navigation property which can be used to directly read and directly modify the failed request in the request queue. The actual entity type of the returned entity will be dependent on the type of request. For example, if the failed request was a PATCH request on the entity Customers(101), then the entity returned by this navigation property will have a Customer entity type. Note that this navigation property differs from AffectedEntity; AffectedEntity returns the CURRENT state of the entity in the Offline Store where as RequestEntity is an typed representation of the request in the request queue itself.

Parameters
value The navigation property which can be used to directly read and directly modify the failed request in the request queue. The actual entity type of the returned entity will be dependent on the type of request. For example, if the failed request was a PATCH request on the entity Customers(101), then the entity returned by this navigation property will have a Customer entity type. Note that this navigation property differs from AffectedEntity; AffectedEntity returns the CURRENT state of the entity in the Offline Store where as RequestEntity is an typed representation of the request in the request queue itself.

public void setRequestID (Long value)

Set the request identifier.

Parameters
value The request identifier.

public void setRequestMethod (String value)

Set the HTTP method used for the request.

Parameters
value The HTTP method used for the request.

public void setRequestURL (String value)

Set the request URL used when executing the request against the OData backend.

Parameters
value The request URL used when executing the request against the OData backend.

public void writeToParcel (Parcel out, int flags)

Internal implementation. Ignore it.