org.compiere.model
Class MAllocationHdr

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_C_AllocationHdr
          org.compiere.model.MAllocationHdr

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, DocAction, Evaluatee

public final class MAllocationHdr
extends X_C_AllocationHdr
implements DocAction

Payment Allocation Model. Allocation Trigger update C_BPartner

Version:

$Id: MAllocationHdr.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_C_AllocationHdr

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

MAllocationHdr(Ctx ctx, boolean IsManual, Timestamp DateTrx, int C_Currency_ID, String description, String trxName)
Mandatory New Constructor

MAllocationHdr(Ctx ctx, int C_AllocationHdr_ID, String trxName)
Standard Constructor

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

Method Summary

void	addDescription(String description) Add to Description
protected boolean	afterSave(boolean newRecord, boolean success) After Save
boolean	approveIt() Approve Document
protected boolean	beforeDelete() Before Delete.
protected boolean	beforeSave(boolean newRecord) Before Save
boolean	closeIt() Close Document.
String	completeIt() Complete Document
static MAllocationHdr	copyFrom(MAllocationHdr from, Timestamp dateAcct, Timestamp dateTrx, String trxName) Create new Allocation by copying
int	copyLinesFrom(MAllocationHdr otherAllocation) Copy Lines From other Allocation.
File	createPDF() Create PDF
File	createPDF(File file) Create PDF file
int	getDoc_User_ID() Get Document Owner (Responsible)
String	getDocumentInfo() Get Document Info
MAllocationLine[]	getLines(boolean requery) Get Lines
static MAllocationHdr[]	getOfInvoice(Ctx ctx, int C_Invoice_ID, String trxName) Get Allocations of Invoice
static MAllocationHdr[]	getOfPayment(Ctx ctx, int C_Payment_ID, String trxName) Get Allocations of Payment
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 - none
boolean	reverseCorrectIt() Reverse Correction
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_C_AllocationHdr

get_AccessLevel, getApprovalAmt, getC_AllocationHdr_ID, getC_Currency_ID, getDateAcct, getDateTrx, getDescription, getDocAction, getDocStatus, getDocumentNo, getKeyNamePair, initPO, isApproved, isDocActionValid, isDocStatusValid, isManual, isPosted, isProcessed, isProcessing, setApprovalAmt, setC_AllocationHdr_ID, setC_Currency_ID, setDateAcct, setDateTrx, setDescription, setDocAction, setDocStatus, setDocumentNo, setIsApproved, setIsManual, setPosted, setProcessing

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, afterDelete, 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, 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, getApprovalAmt, getC_Currency_ID, getCtx, getDocAction, getDocStatus, getDocumentNo, save, setDocStatus

Constructor Detail

MAllocationHdr

public MAllocationHdr(Ctx ctx,
                      int C_AllocationHdr_ID,
                      String trxName)

Standard Constructor

Parameters:

ctx - context

C_AllocationHdr_ID - id

trxName - transaction

MAllocationHdr

public MAllocationHdr(Ctx ctx,
                      boolean IsManual,
                      Timestamp DateTrx,
                      int C_Currency_ID,
                      String description,
                      String trxName)

Mandatory New Constructor

Parameters:

ctx - context

IsManual - manual trx

DateTrx - date (if null today)

C_Currency_ID - currency

description - description

trxName - transaction

MAllocationHdr

public MAllocationHdr(Ctx ctx,
                      ResultSet rs,
                      String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

Method Detail

getOfPayment

public static MAllocationHdr[] getOfPayment(Ctx ctx,
                                            int C_Payment_ID,
                                            String trxName)

Get Allocations of Payment

Parameters:

ctx - context

C_Payment_ID - payment

trxName - transaction

Returns:

allocations of payment

getOfInvoice

public static MAllocationHdr[] getOfInvoice(Ctx ctx,
                                            int C_Invoice_ID,
                                            String trxName)

Get Allocations of Invoice

Parameters:

ctx - context

C_Invoice_ID - payment

trxName - transaction

Returns:

allocations of payment

getLines

public MAllocationLine[] getLines(boolean requery)

Get Lines

Parameters:

requery - if true requery

Returns:

lines

copyFrom

public static MAllocationHdr copyFrom(MAllocationHdr from,
                                      Timestamp dateAcct,
                                      Timestamp dateTrx,
                                      String trxName)

Create new Allocation by copying

Parameters:

from - allocation

dateAcct - date of the document accounting date

dateTrx - date of the document transaction.

trxName - trx

Returns:

Allocation

copyLinesFrom

public int copyLinesFrom(MAllocationHdr otherAllocation)

Copy Lines From other Allocation.

Parameters:

otherAllocation - allocation

Returns:

number of lines copied

addDescription

public void addDescription(String description)

Add to Description

Parameters:

description - text

setProcessed

public void setProcessed(boolean processed)

Set Processed

Overrides:

setProcessed in class X_C_AllocationHdr

Parameters:

processed - Processed

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save

Overrides:

beforeSave in class PO

Parameters:

newRecord -

Returns:

save

beforeDelete

protected boolean beforeDelete()

Before Delete.

Overrides:

beforeDelete in class PO

Returns:

true if acct was deleted

afterSave

protected boolean afterSave(boolean newRecord,
                            boolean success)

After Save

Overrides:

afterSave in class PO

Parameters:

newRecord -

success -

Returns:

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. Same as Close.

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:

false

reActivateIt

public boolean reActivateIt()

Re-activate

Specified by:

reActivateIt in interface DocAction

Returns:

false

toString

public String toString()

String Representation

Overrides:

toString in class X_C_AllocationHdr

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

getSummary

public String getSummary()

Get Summary

Specified by:

getSummary in interface DocAction

Returns:

Summary of Document

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