org.compiere.model
Class MJournalBatch

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_GL_JournalBatch
          org.compiere.model.MJournalBatch

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, 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

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_GL_JournalBatch

accessLevel, 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, Model, POSTINGTYPE_Actual, POSTINGTYPE_AD_Reference_ID, POSTINGTYPE_Budget, POSTINGTYPE_Commitment, POSTINGTYPE_Reservation, POSTINGTYPE_Statistical, Table_ID, Table_Name, updatedMS

Fields inherited from class org.compiere.framework.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, log, p_changeVO, 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, STATUS_Approved, STATUS_Closed, STATUS_Completed, STATUS_Drafted, STATUS_InProgress, STATUS_Invalid, STATUS_NotApproved, STATUS_Reversed, STATUS_Unknown, STATUS_Voided, STATUS_WaitingConfirmation, STATUS_WaitingPayment

Constructor Summary

MJournalBatch(Ctx ctx, int GL_JournalBatch_ID, String trxName)
Standard Construvtore

MJournalBatch(Ctx ctx, ResultSet rs, String trxName)
Load Constructor

MJournalBatch(MJournalBatch original)
Copy Constructor.

Method Summary

boolean	approveIt() Approve Document
boolean	closeIt() Close Document.
String	completeIt() Complete Document
int	copyDetailsFrom(MJournalBatch jb) Copy Journal/Lines from other Journal Batch
static MJournalBatch	copyFrom(Ctx 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
MPeriod	getPeriod() Get Period
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 - same as reverse correct
boolean	rejectIt() Reject Approval
boolean	reverseAccrualIt() Reverse Accrual.
boolean	reverseCorrectIt() Reverse Correction.
void	setC_Period_ID(int C_Period_ID) Set Period
void	setC_Period_ID(String oldC_Period_ID, String newC_Period_ID, int windowNo) Set Period - Callout.
void	setClientOrg(int AD_Client_ID, int AD_Org_ID) Overwrite Client/Org if required
void	setDateAcct(String oldDateAcct, String newDateAcct, int windowNo) Set Acct Date - Callout.
void	setDateAcct(Timestamp DateAcct) Set Accounting Date.
void	setDateDoc(String oldDateDoc, String newDateDoc, int windowNo) Set Doc Date - Callout.
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_ID, getC_DocType_ID, getC_Period_ID, getControlAmt, getCopyFrom, getDateAcct, getDateDoc, getDescription, getDocAction, getDocStatus, getDocumentNo, getGL_Category_ID, getGL_JournalBatch_ID, getKeyNamePair, getPostingType, getTotalCr, getTotalDr, initPO, isApproved, isDocActionValid, isDocStatusValid, isPostingTypeValid, isProcessed, isProcessing, setC_Currency_ID, setC_DocType_ID, setControlAmt, setCopyFrom, setDateDoc, setDescription, setDocAction, setDocStatus, setDocumentNo, setGL_Category_ID, setGL_JournalBatch_ID, setIsApproved, setPostingType, setProcessed, setProcessing, setTotalCr, setTotalDr

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, afterDelete, afterSave, beforeDelete, beforeSave, compare, convertToBigDecimal, convertToBoolean, convertToInt, convertToTimestamp, copy, copyValues, copyValues, createAttachment, delete_Accounting, delete, delete, dump, dump, equals, get_ChangeVO, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_EntityType, get_HashMap, get_ID, get_IDOld, get_Info, get_KeyColumns, get_Logger, get_Table_ID, get_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_ValuesAsString, get_WhereClause, get_xmlDocument, get_xmlString, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getVO, hashCode, insert_Accounting, is_Changed, is_KeyColumn, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveNew_getID, saveNewInsertSQL, saveNewSpecial, saveUpdate, set_ChangeVO, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueString, setAD_Client_ID, setAD_Org_ID, setClientOrg, setContext, setCtx, setDocWorkflowMgr, setIsActive, setStandardDefaults, setUpdateable, setUpdatedBy, toStringX, unlock, update

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

Constructor Detail

MJournalBatch

public MJournalBatch(Ctx 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(Ctx 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(Ctx 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

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

getPeriod

public MPeriod getPeriod()

Get Period

Returns:

period or null

setDateDoc

@UICallout
public void setDateDoc(String oldDateDoc,
                                 String newDateDoc,
                                 int windowNo)
                throws Exception

Set Doc Date - Callout. Sets also acct date and period

Parameters:

oldDateDoc - old

newDateDoc - new

windowNo - window no

Throws:

Exception

setDateAcct

@UICallout
public void setDateAcct(String oldDateAcct,
                                  String newDateAcct,
                                  int windowNo)
                 throws Exception

Set Acct Date - Callout. Sets Period

Parameters:

oldDateAcct - old

newDateAcct - new

windowNo - window no

Throws:

Exception

setC_Period_ID

@UICallout
public void setC_Period_ID(String oldC_Period_ID,
                                     String newC_Period_ID,
                                     int windowNo)
                    throws Exception

Set Period - Callout. Set Acct Date if required

Parameters:

oldC_Period_ID - old

newC_Period_ID - new

windowNo - window no

Throws:

Exception

setDateAcct

public void setDateAcct(Timestamp DateAcct)

Set Accounting Date. Set also Period if not set earlier

Overrides:

setDateAcct in class X_GL_JournalBatch

Parameters:

DateAcct - date

setC_Period_ID

public void setC_Period_ID(int C_Period_ID)

Set Period

Overrides:

setC_Period_ID in class X_GL_JournalBatch

Parameters:

C_Period_ID - period

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:

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