Package org.compiere.process

Class DocActionTemplate

java.lang.Object

org.compiere.model.PO

org.compiere.process.DocActionTemplate

All Implemented Interfaces:

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

public class DocActionTemplate
extends PO
implements DocAction

Template for DocAction Instead of modifying DocumentEngine, you could simply extend DocOptions interface and use customizeValidActions

Version:

$Id: DocActionTemplate.java,v 1.3 2006/07/30 00:54:44 jjanke Exp $

Author:

Jorg Janke

See Also:

• Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
boolean	approveIt()	Approve Document
boolean	closeIt()	Close Document.
String	completeIt()	Complete Document
File	createPDF()	Create PDF
File	createPDF(File file)	Create PDF file
protected int	get_AccessLevel()	Get Table Access Level
BigDecimal	getApprovalAmt()	Get Document Approval Amount
int	getC_Currency_ID()	Get Document Currency
int	getDoc_User_ID()	Get Document Owner (Responsible)
String	getDocAction()	Get Doc Action
String	getDocStatus()	Get Doc 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)	Init PO
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
boolean	save()	Save
void	setDocStatus(String newStatus)	Set Doc Status
boolean	unlockIt()	Unlock Document.
boolean	voidIt()	Void Document.

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, beforeSave, buildInsertSQL, 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_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, 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, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, 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, toInsertSQL, toString, 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, saveEx

Method Details

initPO

protected POInfo initPO(Properties ctx)

Init PO

Specified by:

initPO in class PO

Parameters:

ctx - ctx

Returns:

null

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

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

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:

true if success

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

Get Document no

Specified by:

getDocumentNo in interface DocAction

Returns:

Document No

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

getApprovalAmt

public BigDecimal getApprovalAmt()

Get Document Approval Amount

Specified by:

getApprovalAmt in interface DocAction

Returns:

amount

getC_Currency_ID

public int getC_Currency_ID()

Get Document Currency

Specified by:

getC_Currency_ID in interface DocAction

Returns:

C_Currency_ID

setDocStatus

public void setDocStatus(String newStatus)

Set Doc Status

Specified by:

setDocStatus in interface DocAction

Parameters:

newStatus - status

getDocStatus

public String getDocStatus()

Get Doc Status

Specified by:

getDocStatus in interface DocAction

Returns:

doc status

getDocAction

public String getDocAction()

Get Doc Action

Specified by:

getDocAction in interface DocAction

Returns:

doc action

save

public boolean save()

Save

Specified by:

save in interface DocAction

Overrides:

save in class PO

Returns:

true if saved