Package org.compiere.process

Interface DocAction

All Known Implementing Classes:
DocActionDelegate, DocActionTemplate, DocumentEngine, GenericPO, MAllocationHdr, MAssetAddition, MAssetDisposed, MAssetReval, MAssetTransfer, MBankStatement, MBankTransfer, MCash, MDDOrder, MDepreciationEntry, MInOut, MInOutConfirm, MInventory, MInvoice, MJournal, MJournalBatch, MMovement, MMovementConfirm, MOrder, MPayment, MProduction, MProjectIssue, 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 Details

  • Method Details

    • 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 with document action
      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 for a document action
      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 (typically from Complete to In Progress)
      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 from last execution of a document action
      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

    • saveEx

      void saveEx() throws AdempiereException
      Save throwing exception
      Throws:
      AdempiereException - if save fail
      See Also:

    • 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