org.compiere.model
Class MJournal

java.lang.Object
  org.compiere.model.PO
      org.compiere.model.X_GL_Journal
          org.compiere.model.MJournal

All Implemented Interfaces:

Serializable, Comparator, I_GL_Journal, I_Persistent, DocAction, Evaluatee

public class MJournal
extends X_GL_Journal
implements DocAction

GL Journal Model

Version:

$Id: MJournal.java,v 1.3 2006/07/30 00:51:03 jjanke Exp $

Author:

Jorg Janke, Teo Sarca, SC ARHIPAC SERVICE SRL

BF [ 1619150 ] Usability/Consistency: reversed gl journal description

BF [ 1775358 ] GL Journal DateAcct/C_Period_ID issue, victor.perez@e-evolution.com, e-Evolution

FR [ 1948157 ] Is necessary the reference for document reverse

See Also:

http://sourceforge.net/tracker/?func=detail&atid=879335&aid=1948157&group_id=176962, Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_GL_Journal

C_PERIOD_ID_AD_Reference_ID, 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, POSTINGTYPE_Actual, POSTINGTYPE_AD_Reference_ID, POSTINGTYPE_Budget, POSTINGTYPE_Commitment, POSTINGTYPE_Reservation, POSTINGTYPE_Statistical, REVERSAL_ID_AD_Reference_ID

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, 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_ReOpen, ACTION_Reverse_Accrual, ACTION_Reverse_Correct, ACTION_Unlock, ACTION_Void, ACTION_WaitComplete, AD_REFERENCE_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_GL_Journal

accessLevel, COLUMNNAME_C_AcctSchema_ID, COLUMNNAME_C_ConversionType_ID, COLUMNNAME_C_Currency_ID, COLUMNNAME_C_DocType_ID, COLUMNNAME_C_Period_ID, COLUMNNAME_ControlAmt, COLUMNNAME_CurrencyRate, COLUMNNAME_DateAcct, COLUMNNAME_DateDoc, COLUMNNAME_Description, COLUMNNAME_DocAction, COLUMNNAME_DocStatus, COLUMNNAME_DocumentNo, COLUMNNAME_GL_Budget_ID, COLUMNNAME_GL_Category_ID, COLUMNNAME_GL_Journal_ID, COLUMNNAME_GL_JournalBatch_ID, COLUMNNAME_IsApproved, COLUMNNAME_IsPrinted, COLUMNNAME_Posted, COLUMNNAME_PostingType, COLUMNNAME_Processed, COLUMNNAME_Processing, COLUMNNAME_Reversal_ID, COLUMNNAME_TotalCr, COLUMNNAME_TotalDr, Model, Table_ID, Table_Name

Constructor Summary

MJournal(MJournal original)
Copy Constructor.

MJournal(MJournalBatch parent)
Parent Constructor.

MJournal(Properties ctx, int GL_Journal_ID, String trxName)
Standard Constructor

MJournal(Properties ctx, ResultSet rs, String trxName)
Load Constructor

Method Summary

void	addDescription(String description) Add to Description
protected boolean	afterDelete(boolean success) After Delete
protected boolean	afterSave(boolean newRecord, boolean success) After Save.
boolean	approveIt() Approve Document
protected boolean	beforeSave(boolean newRecord) Before Save
boolean	closeIt() Close Document.
String	completeIt() Complete Document
int	copyLinesFrom(MJournal fromJournal, Timestamp dateAcct, char typeCR) Copy Lines from other Journal
File	createPDF() Create PDF
File	createPDF(File file) Create PDF file
BigDecimal	getApprovalAmt() Get Document Approval Amount
int	getDoc_User_ID() Get Document Owner (Responsible)
String	getDocumentInfo() Get Document Info
MJournalLine[]	getLines(boolean requery) Get Journal Lines
String	getProcessMsg() Get Process Message
String	getSummary() Get Summary
boolean	invalidateIt() Invalidate Document
String	prepareIt() Prepare Document
boolean	processIt(String processAction) Process document
boolean	reActivateIt() Re-activate
boolean	rejectIt() Reject Approval
boolean	reverseAccrualIt() Reverse Accrual (sane batch).
MJournal	reverseAccrualIt(int GL_JournalBatch_ID) Reverse Accrual.
boolean	reverseCorrectIt() Reverse Correction (in same batch).
MJournal	reverseCorrectIt(int GL_JournalBatch_ID) Reverse Correction.
void	setClientOrg(int AD_Client_ID, int AD_Org_ID) Overwrite Client/Org if required
void	setCurrency(int C_Currency_ID, int C_ConversionType_ID, BigDecimal CurrencyRate) Set Currency Info
void	setDateAcct(Timestamp DateAcct) Set Accounting Date.
void	setProcessed(boolean processed) Set Processed.
String	toString() String Representation
boolean	unlockIt() Unlock Document.
boolean	voidIt() Void Document.

Methods inherited from class org.compiere.model.X_GL_Journal

get_AccessLevel, getC_AcctSchema_ID, getC_AcctSchema, getC_ConversionType_ID, getC_ConversionType, getC_Currency_ID, getC_Currency, getC_DocType_ID, getC_DocType, getC_Period_ID, getControlAmt, getCurrencyRate, getDateAcct, getDateDoc, getDescription, getDocAction, getDocStatus, getDocumentNo, getGL_Budget_ID, getGL_Budget, getGL_Category_ID, getGL_Category, getGL_Journal_ID, getGL_JournalBatch_ID, getGL_JournalBatch, getKeyNamePair, getPostingType, getReversal_ID, getTotalCr, getTotalDr, initPO, isApproved, isPosted, isPrinted, isProcessed, isProcessing, setC_AcctSchema_ID, setC_ConversionType_ID, setC_Currency_ID, setC_DocType_ID, setC_Period_ID, setControlAmt, setCurrencyRate, setDateDoc, setDescription, setDocAction, setDocStatus, setDocumentNo, setGL_Budget_ID, setGL_Category_ID, setGL_Journal_ID, setGL_JournalBatch_ID, setIsApproved, setIsPrinted, setPosted, setPostingType, setProcessing, setReversal_ID, setTotalCr, setTotalDr

Methods inherited from class org.compiere.model.PO

beforeDelete, compare, copyValues, copyValues, createAttachment, delete_Accounting, delete_Tree, delete, delete, deleteEx, deleteEx, dump, dump, equals, 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_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveEx, saveEx, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, setAD_Client_ID, setAD_Org_ID, setClientOrg, setDoc, setDocWorkflowMgr, setIsActive, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, setDocStatus

Methods inherited from interface org.compiere.model.I_Persistent

save

Constructor Detail

MJournal

public MJournal(Properties ctx,
                int GL_Journal_ID,
                String trxName)

Standard Constructor

Parameters:

ctx - context

GL_Journal_ID - id

trxName - transaction

MJournal

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MJournal

public MJournal(MJournalBatch parent)

Parent Constructor.

Parameters:

parent - batch

MJournal

public MJournal(MJournal original)

Copy Constructor. Dos not copy: Dates/Period

Parameters:

original - original

Method Detail

setClientOrg

public void setClientOrg(int AD_Client_ID,
                         int AD_Org_ID)

Overwrite Client/Org if required

Overrides:

setClientOrg in class PO

Parameters:

AD_Client_ID - client

AD_Org_ID - org

setDateAcct

public void setDateAcct(Timestamp DateAcct)

Set Accounting Date. Set also Period if not set earlier

Specified by:

setDateAcct in interface I_GL_Journal

Overrides:

setDateAcct in class X_GL_Journal

Parameters:

DateAcct - date

setCurrency

public void setCurrency(int C_Currency_ID,
                        int C_ConversionType_ID,
                        BigDecimal CurrencyRate)

Set Currency Info

Parameters:

C_Currency_ID - currenct

C_ConversionType_ID - type

CurrencyRate - rate

addDescription

public void addDescription(String description)

Add to Description

Parameters:

description - text

Since:

3.1.4

getLines

public MJournalLine[] getLines(boolean requery)

Get Journal Lines

Parameters:

requery - requery

Returns:

Array of lines

copyLinesFrom

public int copyLinesFrom(MJournal fromJournal,
                         Timestamp dateAcct,
                         char typeCR)

Copy Lines from other Journal

Parameters:

fromJournal - Journal

dateAcct - date used - if null original

typeCR - type of copying (C)orrect=negate - (R)everse=flip dr/cr - otherwise just copy

Returns:

number of lines copied

setProcessed

public void setProcessed(boolean processed)

Set Processed. Propergate to Lines/Taxes

Specified by:

setProcessed in interface I_GL_Journal

Overrides:

setProcessed in class X_GL_Journal

Parameters:

processed - processed

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save

Overrides:

beforeSave in class PO

Parameters:

newRecord - new

Returns:

true

afterSave

protected boolean afterSave(boolean newRecord,
                            boolean success)

After Save. Update Batch Total

Overrides:

afterSave in class PO

Parameters:

newRecord - true if new record

success - true if success

Returns:

success

afterDelete

protected boolean afterDelete(boolean success)

After Delete

Overrides:

afterDelete in class PO

Parameters:

success - true if deleted

Returns:

true if success

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)

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 ..)

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 (in same batch). As if nothing happened - same date

Specified by:

reverseCorrectIt in interface DocAction

Returns:

true if success

reverseCorrectIt

public MJournal reverseCorrectIt(int GL_JournalBatch_ID)

Reverse Correction. As if nothing happened - same date

Parameters:

GL_JournalBatch_ID - reversal batch

Returns:

reversed Journal or null

reverseAccrualIt

public boolean reverseAccrualIt()

Reverse Accrual (sane batch). Flip Dr/Cr - Use Today's date

Specified by:

reverseAccrualIt in interface DocAction

Returns:

true if success

reverseAccrualIt

public MJournal reverseAccrualIt(int GL_JournalBatch_ID)

Reverse Accrual. Flip Dr/Cr - Use Today's date

Parameters:

GL_JournalBatch_ID - reversal batch

Returns:

reversed journal or null

reActivateIt

public boolean reActivateIt()

Re-activate

Specified by:

reActivateIt in interface DocAction

Returns:

true if success

getSummary

public String getSummary()

Get Summary

Specified by:

getSummary in interface DocAction

Returns:

Summary of Document

toString

public String toString()

String Representation

Overrides:

toString in class X_GL_Journal

Returns:

info

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

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 (Created)

getApprovalAmt

public BigDecimal getApprovalAmt()

Get Document Approval Amount

Specified by:

getApprovalAmt in interface DocAction

Returns:

DR amount