Package org.compiere.model

Class MJournalBatch

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_GL_JournalBatch

org.compiere.model.MJournalBatch

All Implemented Interfaces:

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

public class MJournalBatch
extends X_GL_JournalBatch
implements DocAction

Journal Batch Model

Version:

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

Author:

Jorg Janke, victor.perez@e-evolution.com, e-Evolution http://www.e-evolution.com

FR [ 1948157 ] Is necessary the reference for document reverse, Teo Sarca, www.arhipac.ro

FR [ 1776045 ] Add ReActivate action to GL Journal

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_justPrepared	Just Prepared Flag
protected String	m_processMsg	Process Message

Fields inherited from class org.compiere.model.X_GL_JournalBatch

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

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_GL_JournalBatch

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_C_Currency_ID, COLUMNNAME_C_DocType_ID, COLUMNNAME_C_Period_ID, COLUMNNAME_ControlAmt, COLUMNNAME_CopyFrom, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_DateAcct, COLUMNNAME_DateDoc, COLUMNNAME_Description, COLUMNNAME_DocAction, COLUMNNAME_DocStatus, COLUMNNAME_DocumentNo, COLUMNNAME_GL_Category_ID, COLUMNNAME_GL_JournalBatch_ID, COLUMNNAME_GL_JournalBatch_UU, COLUMNNAME_IsActive, COLUMNNAME_IsApproved, COLUMNNAME_PostingType, COLUMNNAME_Processed, COLUMNNAME_Processing, COLUMNNAME_Reversal_ID, COLUMNNAME_TotalCr, COLUMNNAME_TotalDr, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MJournalBatch(Properties ctx, int GL_JournalBatch_ID, String trxName)	Standard Construvtore
MJournalBatch(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MJournalBatch(MJournalBatch original)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
void	addDescription(String description)
boolean	approveIt()	Approve Document
protected boolean	beforeSave(boolean newRecord)	Before Save
boolean	closeIt()	Close Document.
String	completeIt()	Complete Document
int	copyDetailsFrom(MJournalBatch jb)	Copy Journal/Lines from other Journal Batch
static MJournalBatch	copyFrom(Properties ctx, int GL_JournalBatch_ID, Timestamp dateDoc, String trxName)	Create new Journal Batch by copying
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
MJournal[]	getJournals(boolean requery)	Get Journal Lines
String	getProcessMsg()	Get Process Message
String	getSummary()	Get Summary
boolean	invalidateIt()	Invalidate Document
boolean	isComplete()	Document Status is Complete or Closed
String	prepareIt()	Prepare Document
boolean	processIt(String processAction)	Process document
boolean	reActivateIt()	Re-activate - same as reverse correct
boolean	rejectIt()	Reject Approval
boolean	reverseAccrualIt()	Reverse Accrual.
boolean	reverseCorrectIt()	Reverse Correction.
void	setClientOrg(int AD_Client_ID, int AD_Org_ID)	Overwrite Client/Org if required
void	setDateAcct(Timestamp DateAcct)	Set Accounting Date.
protected void	setDefiniteDocumentNo()	Set the definite document number after completed
String	toString()	String Representation
boolean	unlockIt()	Unlock Document.
boolean	voidIt()	Void Document.

Methods inherited from class org.compiere.model.X_GL_JournalBatch

get_AccessLevel, getC_Currency, getC_Currency_ID, getC_DocType, getC_DocType_ID, getC_Period, getC_Period_ID, getControlAmt, getCopyFrom, getDateAcct, getDateDoc, getDescription, getDocAction, getDocStatus, getDocumentNo, getGL_Category, getGL_Category_ID, getGL_JournalBatch_ID, getGL_JournalBatch_UU, getKeyNamePair, getPostingType, getReversal, getReversal_ID, getTotalCr, getTotalDr, initPO, isApproved, isProcessed, isProcessing, setC_Currency_ID, setC_DocType_ID, setC_Period_ID, setControlAmt, setCopyFrom, setDateDoc, setDescription, setDocAction, setDocStatus, setDocumentNo, setGL_Category_ID, setGL_JournalBatch_ID, setGL_JournalBatch_UU, setIsApproved, setPostingType, setProcessed, setProcessing, setReversal_ID, setTotalCr, setTotalDr

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

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_processMsg

protected String m_processMsg

Process Message

m_justPrepared

protected boolean m_justPrepared

Just Prepared Flag

Constructor Detail

MJournalBatch

public MJournalBatch(Properties ctx,
                     int GL_JournalBatch_ID,
                     String trxName)

Standard Construvtore

Parameters:

ctx - context

GL_JournalBatch_ID - id if 0 - create actual batch

trxName - transaction

MJournalBatch

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MJournalBatch

public MJournalBatch(MJournalBatch original)

Copy Constructor. Dos not copy: Dates/Period

Parameters:

original - original

Method Detail

copyFrom

public static MJournalBatch copyFrom(Properties ctx,
                                     int GL_JournalBatch_ID,
                                     Timestamp dateDoc,
                                     String trxName)

Create new Journal Batch by copying

Parameters:

ctx - context

GL_JournalBatch_ID - journal batch

dateDoc - date of the document date

trxName - transaction

Returns:

Journal Batch

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_JournalBatch

Overrides:

setDateAcct in class X_GL_JournalBatch

Parameters:

DateAcct - date

getJournals

public MJournal[] getJournals(boolean requery)

Get Journal Lines

Parameters:

requery - requery

Returns:

Array of lines

copyDetailsFrom

public int copyDetailsFrom(MJournalBatch jb)

Copy Journal/Lines from other Journal Batch

Parameters:

jb - Journal Batch

Returns:

number of journals + lines copied

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

setDefiniteDocumentNo

protected void setDefiniteDocumentNo()

Set the definite document number after completed

voidIt

public boolean voidIt()

Void Document.

Specified by:

voidIt in interface DocAction

Returns:

false

closeIt

public boolean closeIt()

Close Document.

Specified by:

closeIt in interface DocAction

Returns:

true if success

reverseCorrectIt

public boolean reverseCorrectIt()

Reverse Correction. As if nothing happened - same date

Specified by:

reverseCorrectIt in interface DocAction

Returns:

true if success

reverseAccrualIt

public boolean reverseAccrualIt()

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

Specified by:

reverseAccrualIt in interface DocAction

Returns:

true if success

reActivateIt

public boolean reActivateIt()

Re-activate - same as reverse correct

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_JournalBatch

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

getApprovalAmt

public BigDecimal getApprovalAmt()

Get Document Approval Amount

Specified by:

getApprovalAmt in interface DocAction

Returns:

DR amount

addDescription

public void addDescription(String description)

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save

Overrides:

beforeSave in class PO

Parameters:

newRecord - new

Returns:

true

isComplete

public boolean isComplete()

Document Status is Complete or Closed

Returns:

true if CO, CL or RE