Package com.clover.sdk.v3.order
Class VoidReasonDetails
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.order.VoidReasonDetails
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class VoidReasonDetails extends GenericParcelable implements Validator, JSONifiable
This is an auto-generated Clover data object.Detailed explanation on why the transaction is getting voided.
Fields
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
VoidReasonDetails.Constraints
-
Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable
JSONifiable.Creator<T>
-
Nested classes/interfaces inherited from interface android.os.Parcelable
Parcelable.ClassLoaderCreator<T extends Object>, Parcelable.Creator<T extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description static Parcelable.Creator<VoidReasonDetails>
CREATOR
static JSONifiable.Creator<VoidReasonDetails>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description VoidReasonDetails()
Constructs a new empty instance.protected
VoidReasonDetails(boolean noInit)
Constructs a new empty instance.VoidReasonDetails(VoidReasonDetails src)
Constructs a new instance that is a deep copy of the source instance.VoidReasonDetails(String json)
Constructs a new instance from the given JSON String.VoidReasonDetails(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearDescription()
Clears the 'description' field, the 'has' method for this field will now return falsevoid
clearOrderId()
Clears the 'orderId' field, the 'has' method for this field will now return falsevoid
clearPayFailureMessage()
Clears the 'payFailureMessage' field, the 'has' method for this field will now return falsevoid
clearPaymentUuid()
Clears the 'paymentUuid' field, the 'has' method for this field will now return falsevoid
clearTxError()
Clears the 'txError' field, the 'has' method for this field will now return falsevoid
clearVoidReasonCode()
Clears the 'voidReasonCode' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.VoidReasonDetails
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.String
getDescription()
More detailed reason for voiding the transactionprotected GenericClient
getGenericClient()
JSONObject
getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.String
getOrderId()
String
getPayFailureMessage()
Pay Failure MessageString
getPaymentUuid()
String
getTxError()
Transaction Error byte in hexVoidReasonCode
getVoidReasonCode()
Detailed Reason codeboolean
hasDescription()
Checks whether the 'description' field has been set, however the value could be nullboolean
hasOrderId()
Checks whether the 'orderId' field has been set, however the value could be nullboolean
hasPayFailureMessage()
Checks whether the 'payFailureMessage' field has been set, however the value could be nullboolean
hasPaymentUuid()
Checks whether the 'paymentUuid' field has been set, however the value could be nullboolean
hasTxError()
Checks whether the 'txError' field has been set, however the value could be nullboolean
hasVoidReasonCode()
Checks whether the 'voidReasonCode' field has been set, however the value could be nullboolean
isNotNullDescription()
Checks whether the 'description' field is set and is not nullboolean
isNotNullOrderId()
Checks whether the 'orderId' field is set and is not nullboolean
isNotNullPayFailureMessage()
Checks whether the 'payFailureMessage' field is set and is not nullboolean
isNotNullPaymentUuid()
Checks whether the 'paymentUuid' field is set and is not nullboolean
isNotNullTxError()
Checks whether the 'txError' field is set and is not nullboolean
isNotNullVoidReasonCode()
Checks whether the 'voidReasonCode' field is set and is not nullvoid
mergeChanges(VoidReasonDetails src)
Copy all the changed fields from the given source to this instance.void
resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.VoidReasonDetails
setDescription(String description)
Sets the field 'description'.VoidReasonDetails
setOrderId(String orderId)
Sets the field 'orderId'.VoidReasonDetails
setPayFailureMessage(String payFailureMessage)
Sets the field 'payFailureMessage'.VoidReasonDetails
setPaymentUuid(String paymentUuid)
Sets the field 'paymentUuid'.VoidReasonDetails
setTxError(String txError)
Sets the field 'txError'.VoidReasonDetails
setVoidReasonCode(VoidReasonCode voidReasonCode)
Sets the field 'voidReasonCode'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<VoidReasonDetails> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<VoidReasonDetails> JSON_CREATOR
-
-
Constructor Detail
-
VoidReasonDetails
public VoidReasonDetails()
Constructs a new empty instance.
-
VoidReasonDetails
protected VoidReasonDetails(boolean noInit)
Constructs a new empty instance.
-
VoidReasonDetails
public VoidReasonDetails(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
VoidReasonDetails
public VoidReasonDetails(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
VoidReasonDetails
public VoidReasonDetails(VoidReasonDetails src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getTxError
public String getTxError()
Transaction Error byte in hex
-
getVoidReasonCode
public VoidReasonCode getVoidReasonCode()
Detailed Reason code
-
getDescription
public String getDescription()
More detailed reason for voiding the transaction
-
getPayFailureMessage
public String getPayFailureMessage()
Pay Failure Message
-
getPaymentUuid
public String getPaymentUuid()
-
getOrderId
public String getOrderId()
-
getGenericClient
protected GenericClient getGenericClient()
- Specified by:
getGenericClient
in classGenericParcelable
-
getJSONObject
public JSONObject getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.- Specified by:
getJSONObject
in interfaceJSONifiable
-
isNotNullTxError
public boolean isNotNullTxError()
Checks whether the 'txError' field is set and is not null
-
isNotNullVoidReasonCode
public boolean isNotNullVoidReasonCode()
Checks whether the 'voidReasonCode' field is set and is not null
-
isNotNullDescription
public boolean isNotNullDescription()
Checks whether the 'description' field is set and is not null
-
isNotNullPayFailureMessage
public boolean isNotNullPayFailureMessage()
Checks whether the 'payFailureMessage' field is set and is not null
-
isNotNullPaymentUuid
public boolean isNotNullPaymentUuid()
Checks whether the 'paymentUuid' field is set and is not null
-
isNotNullOrderId
public boolean isNotNullOrderId()
Checks whether the 'orderId' field is set and is not null
-
hasTxError
public boolean hasTxError()
Checks whether the 'txError' field has been set, however the value could be null
-
hasVoidReasonCode
public boolean hasVoidReasonCode()
Checks whether the 'voidReasonCode' field has been set, however the value could be null
-
hasDescription
public boolean hasDescription()
Checks whether the 'description' field has been set, however the value could be null
-
hasPayFailureMessage
public boolean hasPayFailureMessage()
Checks whether the 'payFailureMessage' field has been set, however the value could be null
-
hasPaymentUuid
public boolean hasPaymentUuid()
Checks whether the 'paymentUuid' field has been set, however the value could be null
-
hasOrderId
public boolean hasOrderId()
Checks whether the 'orderId' field has been set, however the value could be null
-
setTxError
public VoidReasonDetails setTxError(String txError)
Sets the field 'txError'.
-
setVoidReasonCode
public VoidReasonDetails setVoidReasonCode(VoidReasonCode voidReasonCode)
Sets the field 'voidReasonCode'.
-
setDescription
public VoidReasonDetails setDescription(String description)
Sets the field 'description'.
-
setPayFailureMessage
public VoidReasonDetails setPayFailureMessage(String payFailureMessage)
Sets the field 'payFailureMessage'.
-
setPaymentUuid
public VoidReasonDetails setPaymentUuid(String paymentUuid)
Sets the field 'paymentUuid'.
-
setOrderId
public VoidReasonDetails setOrderId(String orderId)
Sets the field 'orderId'.
-
clearTxError
public void clearTxError()
Clears the 'txError' field, the 'has' method for this field will now return false
-
clearVoidReasonCode
public void clearVoidReasonCode()
Clears the 'voidReasonCode' field, the 'has' method for this field will now return false
-
clearDescription
public void clearDescription()
Clears the 'description' field, the 'has' method for this field will now return false
-
clearPayFailureMessage
public void clearPayFailureMessage()
Clears the 'payFailureMessage' field, the 'has' method for this field will now return false
-
clearPaymentUuid
public void clearPaymentUuid()
Clears the 'paymentUuid' field, the 'has' method for this field will now return false
-
clearOrderId
public void clearOrderId()
Clears the 'orderId' field, the 'has' method for this field will now return false
-
containsChanges
public boolean containsChanges()
Returns true if this instance has any changes.
-
resetChangeLog
public void resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
-
copyChanges
public VoidReasonDetails copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(VoidReasonDetails src)
Copy all the changed fields from the given source to this instance.
-
-