Package org.compiere.model

Class MRMA

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_M_RMA

org.compiere.model.MRMA

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_M_RMA, I_Persistent, DocAction, Evaluatee

public class MRMA
extends X_M_RMA
implements DocAction

RMA Model

Version:

$Id: MRMA.java,v 1.3 2006/07/30 00:51:03 jjanke Exp $ Modifications: Completed RMA functionality (Ashley Ramdass)

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected MInOut	m_inout	The Shipment
protected boolean	m_justPrepared	Just Prepared Flag
protected MRMALine[]	m_lines	Lines
protected String	m_processMsg	Process Message
protected MRMATax[]	m_taxes	Tax Lines

Fields inherited from class org.compiere.model.X_M_RMA

DOCACTION_AD_Reference_ID, DOCACTION_Approve, DOCACTION_Close, DOCACTION_Complete, DOCACTION_Invalidate, DOCACTION_None, DOCACTION_Post, DOCACTION_Prepare, DOCACTION_Re_Activate, DOCACTION_Reject, DOCACTION_Reverse_Accrual, DOCACTION_Reverse_Correct, DOCACTION_Unlock, DOCACTION_Void, DOCACTION_WaitComplete, DOCSTATUS_AD_Reference_ID, DOCSTATUS_Approved, DOCSTATUS_Closed, DOCSTATUS_Completed, DOCSTATUS_Drafted, DOCSTATUS_InProgress, DOCSTATUS_Invalid, DOCSTATUS_NotApproved, DOCSTATUS_Reversed, DOCSTATUS_Unknown, DOCSTATUS_Voided, DOCSTATUS_WaitingConfirmation, DOCSTATUS_WaitingPayment

Fields inherited from class org.compiere.model.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.process.DocAction

ACTION_Approve, ACTION_Close, ACTION_Complete, ACTION_Invalidate, ACTION_None, ACTION_Post, ACTION_Prepare, ACTION_ReActivate, ACTION_Reject, ACTION_Reverse_Accrual, ACTION_Reverse_Correct, ACTION_Unlock, ACTION_Void, ACTION_WaitComplete, AD_REFERENCE_ID, DOC_COLUMNNAME_AD_User_ID, DOC_COLUMNNAME_C_Currency_ID, DOC_COLUMNNAME_C_DocType_ID, DOC_COLUMNNAME_C_DocTypeTarget_ID, DOC_COLUMNNAME_DateAcct, DOC_COLUMNNAME_DateTrx, DOC_COLUMNNAME_Description, DOC_COLUMNNAME_DocAction, DOC_COLUMNNAME_DocStatus, DOC_COLUMNNAME_DocumentNo, DOC_COLUMNNAME_IsApproved, DOC_COLUMNNAME_Processed, DOC_COLUMNNAME_Processing, DOC_COLUMNNAME_SalesRep_ID, STATUS_Approved, STATUS_Closed, STATUS_Completed, STATUS_Drafted, STATUS_InProgress, STATUS_Invalid, STATUS_NotApproved, STATUS_Reversed, STATUS_Unknown, STATUS_Voided, STATUS_WaitingConfirmation, STATUS_WaitingPayment

Fields inherited from interface org.compiere.model.I_M_RMA

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_Amt, COLUMNNAME_C_BPartner_ID, COLUMNNAME_C_Currency_ID, COLUMNNAME_C_DocType_ID, COLUMNNAME_C_Order_ID, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_CreateFrom, COLUMNNAME_Description, COLUMNNAME_DocAction, COLUMNNAME_DocStatus, COLUMNNAME_DocumentNo, COLUMNNAME_GenerateTo, COLUMNNAME_Help, COLUMNNAME_InOut_ID, COLUMNNAME_IsActive, COLUMNNAME_IsApproved, COLUMNNAME_IsSOTrx, COLUMNNAME_M_RMA_ID, COLUMNNAME_M_RMA_UU, COLUMNNAME_M_RMAType_ID, COLUMNNAME_Name, COLUMNNAME_Processed, COLUMNNAME_Processing, COLUMNNAME_Ref_RMA_ID, COLUMNNAME_SalesRep_ID, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MRMA(Properties ctx, int M_RMA_ID, String trxName)	Standard Constructor
MRMA(Properties ctx, ResultSet rs, String trxName)	Load Constructor

Method Summary

Modifier and Type	Method	Description
void	addDescription(String description)	Add to Description
boolean	approveIt()	Approve Document
protected boolean	beforeSave(boolean newRecord)	Before Save Set BPartner, Currency
boolean	calculateTaxTotal()	Calculate Tax and Total
boolean	closeIt()	Close Document.
String	completeIt()	Complete Document
static MRMA	copyFrom(MRMA from, int C_DocType_ID, boolean isSOTrx, boolean counter, String trxName)	Create new RMA by copying
int	copyLinesFrom(MRMA otherRMA, boolean counter)	Copy Lines From other RMA
protected MRMA	createCounterDoc()	Create Counter Document
File	createPDF()	Create PDF
File	createPDF(File file)	Create PDF file
BigDecimal	getApprovalAmt()	Get Document Approval Amount
MRMALine[]	getChargeLines()	Retrieves all the charge lines that is present on the document
int	getDoc_User_ID()	Get Document Owner (Responsible)
String	getDocumentInfo()	Get Document Info
MRMALine[]	getLines(boolean requery)	Get Lines
MInvoice	getOriginalInvoice()	Get the original invoice on which the shipment/receipt defined is based upon.
MOrder	getOriginalOrder()	Get the original order on which the shipment/receipt defined is based upon.
int	getPrecision()	Get Currency Precision
String	getProcessMsg()	Get Process Message
MInOut	getShipment()	Get Shipment
String	getSummary()	Get Summary
MRMATax[]	getTaxes(boolean requery)	Get Taxes of RMA
MTaxProvider[]	getTaxProviders()	Get tax providers
boolean	invalidateIt()	Invalidate Document
boolean	isComplete()	Document Status is Complete or Closed
boolean	isTaxIncluded()	Get whether Tax is included (based on the original order)
String	prepareIt()	Prepare Document
boolean	processIt(String processAction)	Process document
boolean	reActivateIt()	Re-activate
boolean	rejectIt()	Reject Approval
boolean	reverseAccrualIt()	Reverse Accrual - none
boolean	reverseCorrectIt()	Reverse Correction
protected void	setDefiniteDocumentNo()	Set the definite document number after completed
void	setM_InOut_ID(int M_InOut_ID)	Set M_InOut_ID
void	setProcessed(boolean processed)	Set Processed.
void	setProcessMessage(String processMsg)	Set process message
boolean	unlockIt()	Unlock Document.
boolean	voidIt()	Void Document.

Methods inherited from class org.compiere.model.X_M_RMA

get_AccessLevel, getAmt, getC_BPartner, getC_BPartner_ID, getC_Currency, getC_Currency_ID, getC_DocType, getC_DocType_ID, getC_Order, getC_Order_ID, getCreateFrom, getDescription, getDocAction, getDocStatus, getDocumentNo, getGenerateTo, getHelp, getInOut, getInOut_ID, getKeyNamePair, getM_RMA_ID, getM_RMA_UU, getM_RMAType, getM_RMAType_ID, getName, getRef_RMA, getRef_RMA_ID, getSalesRep, getSalesRep_ID, initPO, isApproved, isProcessed, isProcessing, isSOTrx, setAmt, setC_BPartner_ID, setC_Currency_ID, setC_DocType_ID, setC_Order_ID, setCreateFrom, setDescription, setDocAction, setDocStatus, setDocumentNo, setGenerateTo, setHelp, setInOut_ID, setIsApproved, setIsSOTrx, setM_RMA_ID, setM_RMA_UU, setM_RMAType_ID, setName, setProcessing, setRef_RMA_ID, setSalesRep_ID, toString

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.process.DocAction

get_ID, get_Logger, get_Table_ID, get_TrxName, getAD_Client_ID, getAD_Org_ID, getC_Currency_ID, getCtx, getDocAction, getDocStatus, getDocumentNo, save, saveEx, setDocStatus

Methods inherited from interface org.compiere.model.I_M_RMA

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Field Detail

m_lines

protected MRMALine[] m_lines

Lines

m_taxes

protected MRMATax[] m_taxes

Tax Lines

m_inout

protected MInOut m_inout

The Shipment

m_processMsg

protected String m_processMsg

Process Message

m_justPrepared

protected boolean m_justPrepared

Just Prepared Flag

Constructor Detail

MRMA

public MRMA(Properties ctx,
            int M_RMA_ID,
            String trxName)

Standard Constructor

Parameters:

ctx - context

M_RMA_ID - id

trxName - transaction

MRMA

public MRMA(Properties ctx,
            ResultSet rs,
            String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

Method Detail

getLines

public MRMALine[] getLines(boolean requery)

Get Lines

Parameters:

requery - requery

Returns:

lines

getTaxes

public MRMATax[] getTaxes(boolean requery)

Get Taxes of RMA

Parameters:

requery - requery

Returns:

array of taxes

getShipment

public MInOut getShipment()

Get Shipment

Returns:

shipment

getOriginalOrder

public MOrder getOriginalOrder()

Get the original order on which the shipment/receipt defined is based upon.

Returns:

order

getOriginalInvoice

public MInvoice getOriginalInvoice()

Get the original invoice on which the shipment/receipt defined is based upon.

Returns:

invoice

setM_InOut_ID

public void setM_InOut_ID(int M_InOut_ID)

Set M_InOut_ID

Parameters:

M_InOut_ID - id

getDocumentInfo

public String getDocumentInfo()

Get Document Info

Specified by:

getDocumentInfo in interface DocAction

Returns:

document info (untranslated)

createPDF

public File createPDF()

Create PDF

Specified by:

createPDF in interface DocAction

Returns:

File or null

createPDF

public File createPDF(File file)

Create PDF file

Parameters:

file - output file

Returns:

file if success

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save Set BPartner, Currency

Overrides:

beforeSave in class PO

Parameters:

newRecord - new

Returns:

true

processIt

public boolean processIt(String processAction)

Process document

Specified by:

processIt in interface DocAction

Parameters:

processAction - document action

Returns:

true if performed

unlockIt

public boolean unlockIt()

Unlock Document.

Specified by:

unlockIt in interface DocAction

Returns:

true if success

invalidateIt

public boolean invalidateIt()

Invalidate Document

Specified by:

invalidateIt in interface DocAction

Returns:

true if success

prepareIt

public String prepareIt()

Prepare Document

Specified by:

prepareIt in interface DocAction

Returns:

new status (In Progress or Invalid)

calculateTaxTotal

public boolean calculateTaxTotal()

Calculate Tax and Total

Returns:

true if tax total calculated

approveIt

public boolean approveIt()

Approve Document

Specified by:

approveIt in interface DocAction

Returns:

true if success

rejectIt

public boolean rejectIt()

Reject Approval

Specified by:

rejectIt in interface DocAction

Returns:

true if success

completeIt

public String completeIt()

Complete Document

Specified by:

completeIt in interface DocAction

Returns:

new status (Complete, In Progress, Invalid, Waiting ..)

setDefiniteDocumentNo

protected void setDefiniteDocumentNo()

Set the definite document number after completed

createCounterDoc

protected MRMA createCounterDoc()

Create Counter Document

Returns:

InOut

copyFrom

public static MRMA copyFrom(MRMA from,
                            int C_DocType_ID,
                            boolean isSOTrx,
                            boolean counter,
                            String trxName)

Create new RMA by copying

Parameters:

from - RMA

C_DocType_ID - doc type

isSOTrx - sales order

counter - create counter links

trxName - trx

Returns:

MRMA

copyLinesFrom

public int copyLinesFrom(MRMA otherRMA,
                         boolean counter)

Copy Lines From other RMA

Parameters:

otherRMA -

counter - set counter info

Returns:

number of lines copied

voidIt

public boolean voidIt()

Void Document.

Specified by:

voidIt in interface DocAction

Returns:

true if success

closeIt

public boolean closeIt()

Close Document. Cancel not delivered Qunatities

Specified by:

closeIt in interface DocAction

Returns:

true if success

reverseCorrectIt

public boolean reverseCorrectIt()

Reverse Correction

Specified by:

reverseCorrectIt in interface DocAction

Returns:

true if success

reverseAccrualIt

public boolean reverseAccrualIt()

Reverse Accrual - none

Specified by:

reverseAccrualIt in interface DocAction

Returns:

true if success

reActivateIt

public boolean reActivateIt()

Re-activate

Specified by:

reActivateIt in interface DocAction

Returns:

true if success

getPrecision

public int getPrecision()

Get Currency Precision

Returns:

precision

setProcessed

public void setProcessed(boolean processed)

Set Processed. Propagate to Lines

Specified by:

setProcessed in interface I_M_RMA

Overrides:

setProcessed in class X_M_RMA

Parameters:

processed - processed

addDescription

public void addDescription(String description)

Add to Description

Parameters:

description - text

getSummary

public String getSummary()

Get Summary

Specified by:

getSummary in interface DocAction

Returns:

Summary of Document

getChargeLines

public MRMALine[] getChargeLines()

Retrieves all the charge lines that is present on the document

Returns:

Charge Lines

isTaxIncluded

public boolean isTaxIncluded()

Get whether Tax is included (based on the original order)

Returns:

True if tax is included

getProcessMsg

public String getProcessMsg()

Get Process Message

Specified by:

getProcessMsg in interface DocAction

Returns:

clear text error message

getDoc_User_ID

public int getDoc_User_ID()

Get Document Owner (Responsible)

Specified by:

getDoc_User_ID in interface DocAction

Returns:

AD_User_ID

getApprovalAmt

public BigDecimal getApprovalAmt()

Get Document Approval Amount

Specified by:

getApprovalAmt in interface DocAction

Returns:

amount

isComplete

public boolean isComplete()

Document Status is Complete or Closed

Returns:

true if CO, CL or RE

setProcessMessage

public void setProcessMessage(String processMsg)

Set process message

Parameters:

processMsg -

getTaxProviders

public MTaxProvider[] getTaxProviders()

Get tax providers

Returns:

array of tax provider