public class Payment extends ModelObject implements java.lang.Comparable
Modifier and Type | Field and Description |
---|---|
static java.lang.String | INVALID_UID
Initial unique identifier assigned to the payment which is an invalid number (-00000000).
|
static java.lang.String | PAYMENT_ACCOUNT_KEY
Payment amount attribute's key ("account").
|
static java.lang.String | PAYMENT_AMOUNT_KEY
Payment amount attribute's key ("piAmount").
|
static java.lang.String | PAYMENT_BILLING_ADDRESS_KEY
Payment billing address attribute's key ("billingAddress").
|
static java.lang.String | PAYMENT_CARD_BRAND
Classic payment card brand attribute's key ("cardBrand").
|
static java.lang.String | PAYMENT_CHECK_ROUTING_NUMBER_KEY
Payment amount attribute's key ("check_routing_number").
|
static java.lang.String | PAYMENT_DATA_EDITABLE_KEY
Payment data editable attribute's key ("paymentDataEditable").
|
static java.lang.String | PAYMENT_EXPIRE_MONTH_KEY
Payment amount attribute's key ("expire_month").
|
static java.lang.String | PAYMENT_EXPIRE_YEAR_KEY
Payment amount attribute's key ("expire_year").
|
static java.lang.String | PAYMENT_ID_KEY
Payment Id attribute's key ("piId").
|
static java.lang.String | PAYMENT_METHOD_ID_KEY
Payment method's id attribute's key ("payMethodId").
|
static java.lang.String | PAYMENT_POLICY_ID
Payment policy ID attribute's key ("policyId").
|
static java.lang.String | PROP_AMOUNT
Constant for the amount property name.
|
static java.lang.String | PROP_ATTRIBUTE
Constant for the attribute property name prefix.
|
static java.lang.String | PROP_BILLING_ADDRESS
Constant for the address property name.
|
static java.lang.String | PROP_COMPATIABLE_MODE
Constant for the compatible mode property name.
|
static java.lang.String | PROP_NAME
Constant for the name property name.
|
static java.lang.String | PROP_PAYMENT_AMOUNT_EDITABLE
Constant for the amountEditable property name.
|
static java.lang.String | PROP_PAYMENT_DATA_EDITABLE
Constant for the paymentDataEditable property name.
|
static java.lang.String | PROP_PAYMENT_METHOD_ID
Constant for the paymentMethodId property name.
|
static java.lang.String | PROP_POLICY_ID
Constant for the payment policy id property name.
|
static java.lang.String | PROP_UID
Constant for the unique identifier property name.
|
static java.lang.String | PROP_VALID
Constant for the valid property name.
|
Constructor and Description |
---|
Payment()
Constructs a new payment.
|
Modifier and Type | Method and Description |
---|---|
void | addAttribute(java.lang.String attributeName, java.lang.String attributeValue)
This method is a convenience method for setting an "attribute." property.
|
int | compareTo(java.lang.Object o)
Compares this object with the specified object for order.
|
java.lang.String | getAmount()
This method is a convenience method for retrieving the current setting of the "amount" property.
|
java.lang.String | getAttribute(java.lang.String name)
This method is a convenience method for retrieving an individual value of the "attribute." properties.
|
java.util.Hashtable | getAttributes()
This method is a convenience method for retrieving all of the "attribute." properties.
|
java.lang.String | getBillingAddress()
This method is a convenience method for retrieving the current setting of the "billingAddress" property.
|
java.lang.String | getName()
This method is a convenience method for retrieving the current setting of the "name" property.
|
java.lang.String | getPaymentAmountEditable()
This method is a convenience method for retrieving the current setting of the "paymentAmountEditable" property.
|
java.lang.String | getPaymentDataEditable()
This method is a convenience method for retrieving the current setting of the "paymentDataEditable" property.
|
java.lang.String | getPaymentMethodId()
This method is a convenience method for retrieving the current setting of the "paymentMethodId" property.
|
java.lang.String | getPolicyId()
This method is a convenience method for retrieving the current setting of the "policyId" property.
|
java.lang.String | getUniqueIdentifier()
This method is a convenience method for retrieving the current setting of the "uid" property.
|
java.lang.String | getValid()
This method is a convenience method for retrieving the current setting of the "valid" property.
|
boolean | isDeletable()
This method is a helper method to determine if a Payment can be deleted or not.
|
boolean | isNotCompatiable()
Returns true if no other payment mode can coexist with this payment, false otherwise.
|
void | setAmount(java.lang.String amount)
This method is a convenience method for setting the "amount" property.
|
void | setBillingAddress(java.lang.String addressId)
This method is a convenience method for setting the "billingAddress" property.
|
void | setName(java.lang.String name)
This method is a convenience method for setting the "name" property.
|
void | setNotCompatiable(java.lang.Boolean notCompatiable)
This method is a convenience method for setting the "compatiableMode" property.
|
void | setPaymentAmountEditable(java.lang.String paymentAmountEditable)
This method is a convenience method for setting the "paymentAmountEditable" property.
|
void | setPaymentDataEditable(java.lang.String paymentDataEditable)
This method is a convenience method for setting the "paymentDataEditable" property.
|
void | setPaymentMethodId(java.lang.String paymentMethodId)
This method is a convenience method for setting the "paymentMethodId" property.
|
void | setPolicyId(java.lang.String policyId)
This method is a convenience method for setting the "policyId" property.
|
void | setUniqueIdentifier(java.lang.String uid)
This method is a convenience method for setting the "uid" property.
|
void | setValid(java.lang.String valid)
This method is a convenience method for setting the "valid" property.
|
public static final java.lang.String INVALID_UID
public static final java.lang.String PAYMENT_METHOD_ID_KEY
public static final java.lang.String PAYMENT_AMOUNT_KEY
public static final java.lang.String PAYMENT_ACCOUNT_KEY
public static final java.lang.String PAYMENT_CHECK_ROUTING_NUMBER_KEY
public static final java.lang.String PAYMENT_EXPIRE_MONTH_KEY
public static final java.lang.String PAYMENT_EXPIRE_YEAR_KEY
public static final java.lang.String PAYMENT_ID_KEY
public static final java.lang.String PAYMENT_DATA_EDITABLE_KEY
public static final java.lang.String PAYMENT_BILLING_ADDRESS_KEY
public static final java.lang.String PAYMENT_CARD_BRAND
public static final java.lang.String PAYMENT_POLICY_ID
public static final java.lang.String PROP_NAME
The value is "name".
The data stored under the "name" property is a String that represents the payment's name.
public static final java.lang.String PROP_BILLING_ADDRESS
The value is "billingAddress".
The data stored under the "billingAddress" property is a String that represents the payment address Id.
public static final java.lang.String PROP_AMOUNT
The value is "amount".
The data stored under the "amount" property is a String that represents the payment amount.
public static final java.lang.String PROP_PAYMENT_METHOD_ID
The value is "paymentMethodId".
The data stored under the "paymentMethodId" property is a String that represents the payment method identifier.
public static final java.lang.String PROP_ATTRIBUTE
The value is "attribute.".
The data stored under property names with the "attribute." prefix is of type String. The full property name is "attribute.name", where name is the name of the attribute.
public static final java.lang.String PROP_PAYMENT_DATA_EDITABLE
The value is "paymentDataEditable".
The data stored under the "paymentDataEditable" property is a boolean value that represents if the payment data is editable.
public static final java.lang.String PROP_PAYMENT_AMOUNT_EDITABLE
The value is "amountEditable".
The data stored under the "amountEditable" property is a boolean value that represents if the payment amount is editable.
public static final java.lang.String PROP_VALID
The value is "valid".
The data stored under the "valid" property is a boolean value that represents if the payment is valid.
public static final java.lang.String PROP_UID
The value is "uid".
The data stored under the "uid" property is a String that represents the payment's unique identifier.
public static final java.lang.String PROP_COMPATIABLE_MODE
The value is "compatiableMode".
The data stored under the "compatiableMode" property is a boolean that represents if this payment mode is compatible with the other payment modes or not. If the compatible mode is true then no other payment mode can coexist with this payment.
public static final java.lang.String PROP_POLICY_ID
The value is "policyId".
The data stored under the "policyId" property is a String that represents if the payment policy ID.
public void addAttribute(java.lang.String attributeName, java.lang.String attributeValue)
public final java.lang.String getAmount()
public java.lang.String getAttribute(java.lang.String name)
public java.util.Hashtable getAttributes()
public final java.lang.String getBillingAddress()
public final java.lang.String getPaymentMethodId()
public final java.lang.String getName()
public final java.lang.String getUniqueIdentifier()
public void setAmount(java.lang.String amount)
public void setBillingAddress(java.lang.String addressId)
public void setPaymentMethodId(java.lang.String paymentMethodId)
public void setName(java.lang.String name)
public void setUniqueIdentifier(java.lang.String uid)
public final java.lang.String getPaymentDataEditable()
public void setPaymentDataEditable(java.lang.String paymentDataEditable)
public final java.lang.String getPaymentAmountEditable()
public void setPaymentAmountEditable(java.lang.String paymentAmountEditable)
public final java.lang.String getValid()
public void setValid(java.lang.String valid)
public int compareTo(java.lang.Object o)
public boolean isDeletable()
public boolean isNotCompatiable()
public void setNotCompatiable(java.lang.Boolean notCompatiable)
public void setPolicyId(java.lang.String policyId)
public final java.lang.String getPolicyId()