org.compiere.process
Interface DocAction

All Known Implementing Classes:

DocActionTemplate, DocumentEngine, MAllocationHdr, MBankStatement, MCash, MDDOrder, MHRProcess, MInOut, MInOutConfirm, MInventory, MInvoice, MJournal, MJournalBatch, MMovement, MMovementConfirm, MOrder, MPayment, MPPCostCollector, MPPOrder, MRequisition, MRMA, MTimeExpense

public interface DocAction

Document Action Interface

Version:

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

Author:

Jorg Janke

Field Summary

static String	ACTION_Approve Approve = AP
static String	ACTION_Close Close = CL
static String	ACTION_Complete Complete = CO
static String	ACTION_Invalidate Invalidate = IN
static String	ACTION_None = --
static String	ACTION_Post Post = PO
static String	ACTION_Prepare Prepare = PR
static String	ACTION_ReActivate ReActivate = RE
static String	ACTION_Reject Reject = RJ
static String	ACTION_ReOpen ReOpen = OP
static String	ACTION_Reverse_Accrual Reverse - Accrual = RA
static String	ACTION_Reverse_Correct Reverse - Correct = RC
static String	ACTION_Unlock Unlock = XL
static String	ACTION_Void Void = VO
static String	ACTION_WaitComplete Wait Complete = WC
static int	AD_REFERENCE_ID DocAction Ref_List values
static String	STATUS_Approved Approved = AP
static String	STATUS_Closed Closed = CL
static String	STATUS_Completed Completed = CO
static String	STATUS_Drafted Drafted = DR
static String	STATUS_InProgress In Progress = IP
static String	STATUS_Invalid Invalid = IN
static String	STATUS_NotApproved Not Approved = NA
static String	STATUS_Reversed Reversed = RE
static String	STATUS_Unknown Unknown = ??
static String	STATUS_Voided Voided = VO
static String	STATUS_WaitingConfirmation Waiting Confirmation = WC
static String	STATUS_WaitingPayment Waiting Payment = WP

Method Summary

boolean	approveIt() Approve Document
boolean	closeIt() Close Document
String	completeIt() Complete Document
File	createPDF() Create PDF
int	get_ID() Get ID of record
CLogger	get_Logger() Get Logger
int	get_Table_ID() Get AD_Table_ID
String	get_TrxName() Get Transaction
int	getAD_Client_ID() Get Document Client
int	getAD_Org_ID() Get Document Organization
BigDecimal	getApprovalAmt() Get Document Approval Amount
int	getC_Currency_ID() Get Document Currency
Properties	getCtx() Get Context
int	getDoc_User_ID() Get Document Owner
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
boolean	invalidateIt() Invalidate Document
String	prepareIt() Prepare Document
boolean	processIt(String action) Process document
boolean	reActivateIt() Re-activate
boolean	rejectIt() Reject Approval
boolean	reverseAccrualIt() Reverse Accrual
boolean	reverseCorrectIt() Reverse Correction
boolean	save() Save Document
void	setDocStatus(String newStatus) Set Doc Status
boolean	unlockIt() Unlock Document.
boolean	voidIt() Void Document

Field Detail

ACTION_Complete

static final String ACTION_Complete

Complete = CO

See Also:

Constant Field Values

ACTION_WaitComplete

static final String ACTION_WaitComplete

Wait Complete = WC

See Also:

Constant Field Values

ACTION_Approve

static final String ACTION_Approve

Approve = AP

See Also:

Constant Field Values

ACTION_Reject

static final String ACTION_Reject

Reject = RJ

See Also:

Constant Field Values

ACTION_Post

static final String ACTION_Post

Post = PO

See Also:

Constant Field Values

ACTION_Void

static final String ACTION_Void

Void = VO

See Also:

Constant Field Values

ACTION_Close

static final String ACTION_Close

Close = CL

See Also:

Constant Field Values

ACTION_Reverse_Correct

static final String ACTION_Reverse_Correct

Reverse - Correct = RC

See Also:

Constant Field Values

ACTION_Reverse_Accrual

static final String ACTION_Reverse_Accrual

Reverse - Accrual = RA

See Also:

Constant Field Values

ACTION_ReActivate

static final String ACTION_ReActivate

ReActivate = RE

See Also:

Constant Field Values

ACTION_None

static final String ACTION_None

= --

See Also:

Constant Field Values

ACTION_Prepare

static final String ACTION_Prepare

Prepare = PR

See Also:

Constant Field Values

ACTION_Unlock

static final String ACTION_Unlock

Unlock = XL

See Also:

Constant Field Values

ACTION_Invalidate

static final String ACTION_Invalidate

Invalidate = IN

See Also:

Constant Field Values

ACTION_ReOpen

static final String ACTION_ReOpen

ReOpen = OP

See Also:

Constant Field Values

STATUS_Drafted

static final String STATUS_Drafted

Drafted = DR

See Also:

Constant Field Values

STATUS_Completed

static final String STATUS_Completed

Completed = CO

See Also:

Constant Field Values

STATUS_Approved

static final String STATUS_Approved

Approved = AP

See Also:

Constant Field Values

STATUS_Invalid

static final String STATUS_Invalid

Invalid = IN

See Also:

Constant Field Values

STATUS_NotApproved

static final String STATUS_NotApproved

Not Approved = NA

See Also:

Constant Field Values

STATUS_Voided

static final String STATUS_Voided

Voided = VO

See Also:

Constant Field Values

STATUS_Reversed

static final String STATUS_Reversed

Reversed = RE

See Also:

Constant Field Values

STATUS_Closed

static final String STATUS_Closed

Closed = CL

See Also:

Constant Field Values

STATUS_Unknown

static final String STATUS_Unknown

Unknown = ??

See Also:

Constant Field Values

STATUS_InProgress

static final String STATUS_InProgress

In Progress = IP

See Also:

Constant Field Values

STATUS_WaitingPayment

static final String STATUS_WaitingPayment

Waiting Payment = WP

See Also:

Constant Field Values

STATUS_WaitingConfirmation

static final String STATUS_WaitingConfirmation

Waiting Confirmation = WC

See Also:

Constant Field Values

AD_REFERENCE_ID

static final int AD_REFERENCE_ID

DocAction Ref_List values

See Also:

Constant Field Values

Method Detail

setDocStatus

void setDocStatus(String newStatus)

Set Doc Status

Parameters:

newStatus - new Status

getDocStatus

String getDocStatus()

Get Doc Status

Returns:

Document Status

processIt

boolean processIt(String action)
                  throws Exception

Process document

Parameters:

action - document action

Returns:

true if performed

Throws:

Exception

unlockIt

boolean unlockIt()

Unlock Document.

Returns:

true if success

invalidateIt

boolean invalidateIt()

Invalidate Document

Returns:

true if success

prepareIt

String prepareIt()

Prepare Document

Returns:

new status (In Progress or Invalid)

approveIt

boolean approveIt()

Approve Document

Returns:

true if success

rejectIt

boolean rejectIt()

Reject Approval

Returns:

true if success

completeIt

String completeIt()

Complete Document

Returns:

new status (Complete, In Progress, Invalid, Waiting ..)

voidIt

boolean voidIt()

Void Document

Returns:

true if success

closeIt

boolean closeIt()

Close Document

Returns:

true if success

reverseCorrectIt

boolean reverseCorrectIt()

Reverse Correction

Returns:

true if success

reverseAccrualIt

boolean reverseAccrualIt()

Reverse Accrual

Returns:

true if success

reActivateIt

boolean reActivateIt()

Re-activate

Returns:

true if success

getSummary

String getSummary()

Get Summary

Returns:

Summary of Document

getDocumentNo

String getDocumentNo()

Get Document No

Returns:

Document No

getDocumentInfo

String getDocumentInfo()

Get Document Info

Returns:

Type and Document No

createPDF

File createPDF()

Create PDF

Returns:

file

getProcessMsg

String getProcessMsg()

Get Process Message

Returns:

clear text message

getDoc_User_ID

int getDoc_User_ID()

Get Document Owner

Returns:

AD_User_ID

getC_Currency_ID

int getC_Currency_ID()

Get Document Currency

Returns:

C_Currency_ID

getApprovalAmt

BigDecimal getApprovalAmt()

Get Document Approval Amount

Returns:

amount

getAD_Client_ID

int getAD_Client_ID()

Get Document Client

Returns:

AD_Client_ID

getAD_Org_ID

int getAD_Org_ID()

Get Document Organization

Returns:

AD_Org_ID

getDocAction

String getDocAction()

Get Doc Action

Returns:

Document Action

save

boolean save()

Save Document

Returns:

true if saved

getCtx

Properties getCtx()

Get Context

Returns:

context

get_ID

int get_ID()

Get ID of record

Returns:

ID

get_Table_ID

int get_Table_ID()

Get AD_Table_ID

Returns:

AD_Table_ID

get_Logger

CLogger get_Logger()

Get Logger

Returns:

logger

get_TrxName

String get_TrxName()

Get Transaction

Returns:

trx name