Package org.adempiere.model

Class GenericPO

java.lang.Object

org.compiere.model.PO

org.adempiere.model.GenericPO

All Implemented Interfaces:

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

public class GenericPO
extends PO
implements DocAction

Generic PO implementation, this can be use together with ModelValidator as alternative to the classic generated model class and extend ( X_ and M_ ) approach. Originally for used to insert/update data from adempieredata.xml file in 2pack.

Author:

Marco LOMBARDO

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	AD_ORGTRX_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, 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

Constructor Summary

Constructors

Constructor	Description
GenericPO(String tableName, Properties ctx, int ID)
GenericPO(String tableName, Properties ctx, int ID, String trxName)
GenericPO(String tableName, Properties ctx, ResultSet rs)
GenericPO(String tableName, Properties ctx, ResultSet rs, String trxName)

Method Summary

Modifier and Type	Method	Description
boolean	approveIt()	Approve Document
boolean	closeIt()	Close Document.
String	completeIt()	Complete Document
File	createPDF()	Create PDF
protected int	get_AccessLevel()	Get Table Access Level
int	getAD_OrgTrx_ID()	Get Trx Organization.
BigDecimal	getApprovalAmt()	Get Document Approval Amount
int	getC_Currency_ID()	Get Currency.
int	getDoc_User_ID()	Get Document Owner
String	getDocAction()	Get Document Action.
String	getDocStatus()	Get Document Status.
String	getDocumentInfo()	Get Document Info
String	getDocumentNo()	Get Document No
String	getProcessMsg()	Get Process Message
String	getSummary()	Get Summary
protected POInfo	initPO(Properties ctx)	Load Meta Data
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 - same date
void	setAD_OrgTrx_ID(int AD_OrgTrx_ID)	Set Trx Organization.
void	setDocStatus(String DocStatus)	Set Document Status.
String	toString()	String representation
boolean	unlockIt()	Unlock Document.
boolean	voidIt()	Void Document.

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, beforeSave, 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, getCtx, save, saveEx

Field Detail

AD_ORGTRX_ID_AD_Reference_ID

public static final int AD_ORGTRX_ID_AD_Reference_ID

See Also:

Constant Field Values

Constructor Detail

GenericPO

public GenericPO(String tableName,
                 Properties ctx,
                 int ID)

Parameters:

tableName -

ctx -

ID -

GenericPO

public GenericPO(String tableName,
                 Properties ctx,
                 ResultSet rs)

Parameters:

tableName -

ctx -

rs -

GenericPO

public GenericPO(String tableName,
                 Properties ctx,
                 int ID,
                 String trxName)

Parameters:

tableName -

ctx -

ID -

trxName -

GenericPO

public GenericPO(String tableName,
                 Properties ctx,
                 ResultSet rs,
                 String trxName)

Parameters:

tableName -

ctx -

rs -

trxName -

Method Detail

initPO

protected POInfo initPO(Properties ctx)

Load Meta Data

Specified by:

initPO in class PO

Parameters:

ctx - context

Returns:

POInfo

toString

public String toString()

Description copied from class: PO

String representation

Overrides:

toString in class PO

Returns:

String representation

setAD_OrgTrx_ID

public void setAD_OrgTrx_ID(int AD_OrgTrx_ID)

Set Trx Organization. Performing or initiating organization

getAD_OrgTrx_ID

public int getAD_OrgTrx_ID()

Get Trx Organization. Performing or initiating organization

get_AccessLevel

protected int get_AccessLevel()

Description copied from class: PO

Get Table Access Level

Specified by:

get_AccessLevel in class PO

Returns:

Access Level

setDocStatus

public void setDocStatus(String DocStatus)

Set Document Status.

Specified by:

setDocStatus in interface DocAction

Parameters:

DocStatus - The current status of the document

getDocStatus

public String getDocStatus()

Get Document Status.

Specified by:

getDocStatus in interface DocAction

Returns:

The current status of the document

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

getDocAction

public String getDocAction()

Get Document Action.

Specified by:

getDocAction in interface DocAction

Returns:

The targeted status of the document

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.

Specified by:

closeIt in interface DocAction

Returns:

true if success

reverseCorrectIt

public boolean reverseCorrectIt()

Reverse Correction - same date

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:

true if success

getSummary

public String getSummary()

Get Summary

Specified by:

getSummary in interface DocAction

Returns:

Summary of Document

getDocumentNo

public String getDocumentNo()

Description copied from interface: DocAction

Get Document No

Specified by:

getDocumentNo in interface DocAction

Returns:

Document No

getDocumentInfo

public String getDocumentInfo()

Get Document Info

Specified by:

getDocumentInfo in interface DocAction

Returns:

document info (untranslated)

createPDF

public File createPDF()

Description copied from interface: DocAction

Create PDF

Specified by:

createPDF in interface DocAction

Returns:

file

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

Description copied from interface: DocAction

Get Document Owner

Specified by:

getDoc_User_ID in interface DocAction

Returns:

AD_User_ID

getC_Currency_ID

public int getC_Currency_ID()

Get Currency.

Specified by:

getC_Currency_ID in interface DocAction

Returns:

The Currency for this record

getApprovalAmt

public BigDecimal getApprovalAmt()

Description copied from interface: DocAction

Get Document Approval Amount

Specified by:

getApprovalAmt in interface DocAction

Returns:

amount