public class Return extends Session
Modifier and Type | Field and Description |
---|---|
static java.lang.String | INIT_RMAID
The RMA Id that a newly created Return object is given value is "00"
|
static java.lang.String | PROP_ALLOWED_CREDIT_LINE_TYPES
Constant for the allowed credit line types property name.
|
static java.lang.String | PROP_ALLOWED_PAYMENT_TYPES
Constant for the allowed payment types property name.
|
static java.lang.String | PROP_ALLOWED_REFUND_POLICIES
Constant for the allowed refund policies property name.
|
static java.lang.String | PROP_APPROVED_BY
Constant for the approved by property name.
|
static java.lang.String | PROP_COMMENT
Constant for the comment property name.
|
static java.lang.String | PROP_CONTRACT
Constant for the contract property name.
|
static java.lang.String | PROP_CURRENCY
Constant for the currency property name.
|
static java.lang.String | PROP_CUSTOMER
Constant for the customer property name.
|
static java.lang.String | PROP_DATE_CREATED
Constant for the date created property name.
|
static java.lang.String | PROP_FULFILLMENT_CENTER
Constant for the fulfillment center property name.
|
static java.lang.String | PROP_IS_EDIT_STARTED
Constant for the is edit started property name.
|
static java.lang.String | PROP_IS_LOCKED
Constant for the is locked property name.
|
static java.lang.String | PROP_ITEMS
Constant for the items property name.
|
static java.lang.String | PROP_LAST_UPDATED
Constant for the last updated property name.
|
static java.lang.String | PROP_OTHER_CHARGES
Constant for the other charges property name.
|
static java.lang.String | PROP_PAYMENT_METHOD_ORDER_ID
Constant for the payment method order ID property name.
|
static java.lang.String | PROP_REFUND_PAYMENT_TYPE
Constant for the refund payment type property name.
|
static java.lang.String | PROP_REFUND_POLICY_ID
Constant for the refund policy ID property name.
|
static java.lang.String | PROP_RMA_ID
Constant for the RMA ID property name.
|
static java.lang.String | PROP_RMA_STATUS
Constant for the RMA status property name.
|
static java.lang.String | PROP_STATUS_LABEL
Constant for the RMA status label property name.
|
static java.lang.String | PROP_STORE_ID
Constant for the store ID property name.
|
static java.lang.String | PROP_TAX
Constant for the tax property name.
|
static java.lang.String | PROP_TOTAL_CREDIT
Constant for the total credit property name.
|
static java.lang.String | PROP_TOTAL_CREDIT_AMOUNT
Constant for the total credit amount property name.
|
static java.lang.String | PROP_UNIQUE_ID
Constant for the unique ID property name.
|
static java.lang.String | STATUS_APP
Status constant (value "APP") which identifies a RMA status.
|
static java.lang.String | STATUS_CAN
Status constant (value "CAN") which identifies a RMA status.
|
static java.lang.String | STATUS_CLO
Status constant (value "CLO") which identifies a RMA status.
|
static java.lang.String | STATUS_EDT
Status constant (value "EDT") which identifies a RMA status.
|
static java.lang.String | STATUS_PND
Status constant (value "PND") which identifies a RMA status.
|
static java.lang.String | STATUS_PRC
Status constant (value "PRC") which identifies a RMA status.
|
Constructor and Description |
---|
Return()
Constructor for Return.
|
Modifier and Type | Method and Description |
---|---|
void | addItem(ReturnItem item)
This method is a convenience method for updating the "items" property.
|
java.util.HashSet | getAvailOrderIDs()
This method returns the set of unique order IDs for this return.
|
java.lang.String | getComment()
This method is a convenience method for retrieving the current setting of the "comment" property.
|
Contract | getContract()
This method is a convenience method for retrieving the current setting of the "contract" property.
|
java.lang.String | getCurrency()
This method is a convenience method for retrieving the current setting of the "curency" property.
|
java.lang.String | getCurrencyCode()
This method gets the currency code.
|
Customer | getCustomer()
This method is a convenience method for retrieving the current setting of the "customer" property.
|
java.lang.String | getDateCreated()
This method is a convenience method for retrieving the current setting of the "dateCreated" property.
|
FFMCenter | getFfmCenter()
This method is a convenience method for retrieving the current setting of the "ffmCenter" property.
|
java.util.List | getItems()
This method is a convenience method for retrieving the current setting of the "items" property.
|
java.lang.String | getLastUpdated()
This method is a convenience method for retrieving the current setting of the "lastUpdated" property.
|
java.lang.String | getOtherCharges()
This method is a convenience method for retrieving the current setting of the "otherCharges" property.
|
java.lang.String | getPayMethodOrderId()
This method is a convenience method for retrieving the current setting of the "payMethodOrderId" property.
|
java.lang.String | getRefundPaymentTypeId()
This method is a convenience method for retrieving the current setting of the "refundPaymentType" property.
|
java.lang.String | getRefundPolicyId()
This method is a convenience method for retrieving the current setting of the "refundPolicyId" property.
|
java.lang.String | getRmaId()
This method is a convenience method for retrieving the current setting of the "rmaId" property.
|
java.lang.String | getRmaStatus()
This method is a convenience method for retrieving the current setting of the "rmaStatus" property.
|
java.lang.String | getStatusLabel()
This method returns a displayable string representation of the status code.
|
java.lang.String | getStoreId()
This method is a convenience method for retrieving the current setting of the "storeId" property.
|
java.lang.String | getTax()
This method is a convenience method for retrieving the current setting of the "tax" property.
|
java.lang.String | getTotalCredit()
This method is a convenience method for retrieving the current setting of the "totalCredit" property.
|
java.lang.String | getTotalCreditAmount()
This method is a convenience method for retrieving the current setting of the "totalCreditAmount" property.
|
java.lang.String | getUniqueId()
This method is a convenience method for retrieving the current setting of the "uniqueId" property.
|
boolean | isEditable()
This method is a convenience method for determining if the Return is editable.
|
boolean | isEditStarted()
This method returns the "editStarted" flag
|
boolean | isLocked()
This method returns the "locked" flag
|
boolean | isNew()
This method returns a boolean indicating if the RMA is yet to be submitted (for the first time)
|
void | setComment(java.lang.String comment)
This method is a convenience method for setting the "comment" property.
|
void | setContract(Contract contract)
This method is a convenience method for setting the "contract" property.
|
void | setCurrency(java.lang.String currency)
This method is a convenience method for setting the "currency" property.
|
void | setCustomer(Customer customer)
This method is a convenience method for setting the "customer" property.
|
void | setDateCreated(java.lang.String dateCreated)
This method is a convenience method for setting the "dateCreated" property.
|
void | setEditStarted(boolean editStarted)
This method sets the "editStarted" flag for the RMA
|
void | setFfmCenter(FFMCenter ffmCenter)
This method is a convenience method for setting the "ffmCenter" property.
|
void | setItems(java.util.ArrayList items)
This method is a convenience method for setting the "items" property.
|
void | setLastUpdated(java.lang.String lastUpdated)
This method is a convenience method for setting the "lastUpdated" property.
|
void | setLocked(boolean lock)
This method sets the "Locked" flag for the RMA
|
void | setOtherCharges(java.lang.String otherCharges)
This method is a convenience method for setting the "otherCharges" property.
|
void | setPayMethodOrderId(java.lang.String payMethodOrderId)
This method is a convenience method for setting the "payMethodOrderId" property.
|
void | setRefundPaymentTypeId(java.lang.String refundPaymentTypeId)
This method is a convenience method for setting the "refundPaymentType" property.
|
void | setRefundPolicyId(java.lang.String refundPolicyId)
This method is a convenience method for setting the "refundPolicyId" property.
|
void | setRmaId(java.lang.String rmaId)
This method is a convenience method for setting the "rmaId" property.
|
void | setRmaStatus(java.lang.String rmaStatus)
This method is a convenience method for setting the "rmaStatus" property.
|
void | setStatusLabel(java.lang.String statusCode)
This method returns a displayable string representation of the RMA status code.
|
void | setStoreId(java.lang.String storeId)
This method is a convenience method for setting the "storeId" property.
|
void | setTax(java.lang.String tax)
This method is a convenience method for setting the "tax" property.
|
void | setTotalCredit(java.lang.String totalCredit)
This method is a convenience method for setting the "totalCredit" property.
|
void | setTotalCreditAmount(java.lang.String totalCreditAmount)
This method is a convenience method for setting the "totalCreditAmount" property.
|
void | setUniqueId(java.lang.String uniqueId)
This method is a convenience method for setting the "uniqueId" property.
|
java.lang.String | toString()
This method returns a string representation of this return.
|
public static final java.lang.String PROP_RMA_ID
Value is "rmaId"
The data stored under the "rmaId" property is a String that contains the primary id of the rma.
public static final java.lang.String PROP_RMA_STATUS
Value is "rmaStatus"
The data stored under the "rmaStatus" property is a String that contains the status of the rma.
public static final java.lang.String PROP_STATUS_LABEL
The value is "statusLabel".
The data stored under the "statusLabel" property is a String that represents the displayable status of this return.
public static final java.lang.String PROP_LAST_UPDATED
Value is "lastUpdated"
The data stored under the "lastUpdated" property is a String that contains the Date and time of last update.
public static final java.lang.String PROP_STORE_ID
Value is "storeId"
The data stored under the "storeId" property is a String that contains the store id.
public static final java.lang.String PROP_DATE_CREATED
Value is "dateCreated"
The data stored under the "dateCreated" property is a String that contains the Date of creation.
public static final java.lang.String PROP_CUSTOMER
Value is "customer"
The data stored under the "customer" property is a Customer who owns this RMA.
public static final java.lang.String PROP_CONTRACT
Value is "contract"
The data stored under the "contract" property is a Contract. that contains the contract information.
public static final java.lang.String PROP_FULFILLMENT_CENTER
Value is "ffmCenter"
The data stored under the "ffmCenter" property is a FFMCenter that contains the fulfillment center information
public static final java.lang.String PROP_CURRENCY
Value is "currency"
The data stored under the "currency" property is a String that contains the currency.
public static final java.lang.String PROP_TOTAL_CREDIT
Value is "totalCredit"
The data stored under the "totalCredit" property is a String that contains the total credit amount.
public static final java.lang.String PROP_TAX
Value is "tax"
The data stored under the "tax" property is a String that contains the total tax amount.
public static final java.lang.String PROP_OTHER_CHARGES
Value is "otherCharges"
The data stored under the "otherCharges" property is a String that contains the other charges amount.
public static final java.lang.String PROP_PAYMENT_METHOD_ORDER_ID
Value is "payMethodOrderId"
The data stored under the "payMethodOrderId" property is a String that contains the order ID whose payment method is going to be used for refund.
public static final java.lang.String PROP_REFUND_POLICY_ID
Value is "refundPolicyId"
The data stored under the "refundPolicyId" property is a String that contains the refund policy ID to be used for refund.
public static final java.lang.String PROP_REFUND_PAYMENT_TYPE
Value is "refundPaymentType"
The data stored under the "refundPaymentType" property is a String that contains the refund payment type to be used for refund.
public static final java.lang.String PROP_ALLOWED_REFUND_POLICIES
Value is "allowedRefundPolicies"
The data stored under the "allowedRefundPolicies" property is a HashMap that contains the refund policies allowed for returns.
public static final java.lang.String PROP_ALLOWED_PAYMENT_TYPES
Value is "allowedPaymentTypes"
The data stored under the "allowedPaymentTypes" property is a HashMap that contains the refund payment policies allowed for returns.
public static final java.lang.String PROP_ALLOWED_CREDIT_LINE_TYPES
Value is "allowedCreditLineTypes"
The data stored under the "allowedCreditLineTypes" property is a HashMap that contains the credit lines allowed for returns.
public static final java.lang.String PROP_ITEMS
Value is "items"
The data stored under the "items" property is an ArrayList that contains the list of ReturnItem objects.
public static final java.lang.String PROP_APPROVED_BY
Value is "approvedBy"
The data stored under the "approvedBy" property is a String that contains the user ID of the approver.
public static final java.lang.String PROP_TOTAL_CREDIT_AMOUNT
Value is "totalCreditAmount"
The data stored under the "totalCreditAmount" property is a String that contains the total refund value for the RMA.
public static final java.lang.String PROP_COMMENT
Value is "comment"
The data stored under the "comment" property is a String that contains the comment for the RMA.
public static final java.lang.String PROP_UNIQUE_ID
Value is "uniqueId"
The data stored under the "uniqueId" property is a String that contains a unique ID for this RMA.
public static final java.lang.String PROP_IS_LOCKED
Value is "isLocked"
The data stored under the "isLocked" property is a Boolean that contains the flag to indicate that the RMA is locked for editing
public static final java.lang.String PROP_IS_EDIT_STARTED
Value is "isEditStarted"
The data stored under the "isEditStarted" property is a Boolean that contains the flag to indicate that the RMA is being edited.
public static final java.lang.String INIT_RMAID
public static final java.lang.String STATUS_CAN
public static final java.lang.String STATUS_CLO
public static final java.lang.String STATUS_EDT
public static final java.lang.String STATUS_PRC
public static final java.lang.String STATUS_PND
public static final java.lang.String STATUS_APP
public java.lang.String getTotalCreditAmount()
public void setTotalCreditAmount(java.lang.String totalCreditAmount)
public Contract getContract()
public void setContract(Contract contract)
public java.lang.String getCurrency()
public void setCurrency(java.lang.String currency)
public Customer getCustomer()
public void setCustomer(Customer customer)
public java.lang.String getDateCreated()
public void setDateCreated(java.lang.String dateCreated)
public FFMCenter getFfmCenter()
public void setFfmCenter(FFMCenter ffmCenter)
public java.util.List getItems()
public void setItems(java.util.ArrayList items)
public java.util.HashSet getAvailOrderIDs()
public void addItem(ReturnItem item)
public java.lang.String getLastUpdated()
public void setLastUpdated(java.lang.String lastUpdated)
public java.lang.String getOtherCharges()
public void setOtherCharges(java.lang.String otherCharges)
public java.lang.String getPayMethodOrderId()
public void setPayMethodOrderId(java.lang.String payMethodOrderId)
public java.lang.String getRmaId()
public void setRmaId(java.lang.String rmaId)
public java.lang.String getRmaStatus()
public void setRmaStatus(java.lang.String rmaStatus)
public boolean isNew()
public java.lang.String getStoreId()
public void setStoreId(java.lang.String storeId)
public java.lang.String getTax()
public void setTax(java.lang.String tax)
public java.lang.String getTotalCredit()
public void setTotalCredit(java.lang.String totalCredit)
public java.lang.String getUniqueId()
public void setUniqueId(java.lang.String uniqueId)
public java.lang.String getComment()
public void setComment(java.lang.String comment)
public boolean isEditable()
public java.lang.String toString()
public java.lang.String getCurrencyCode()
public java.lang.String getRefundPolicyId()
public void setRefundPolicyId(java.lang.String refundPolicyId)
public java.lang.String getRefundPaymentTypeId()
public void setRefundPaymentTypeId(java.lang.String refundPaymentTypeId)
public java.lang.String getStatusLabel()
public void setStatusLabel(java.lang.String statusCode)
public boolean isLocked()
public void setLocked(boolean lock)
public boolean isEditStarted()
public void setEditStarted(boolean editStarted)