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
@Deprecated(since="13", forRemoval=true) public class DocActionTemplate extends PO implements DocAction
Deprecated, for removal: This API element is subject to removal in a future version.
not fully implemented
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:

  • Method Details

    • initPO

      protected POInfo initPO(Properties ctx)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Init PO
      Specified by:
      initPO in class PO
      Parameters:
      ctx - ctx
      Returns:
      null

    • get_AccessLevel

      protected int get_AccessLevel()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from class: PO
      Get Table Access Level
      Specified by:
      get_AccessLevel in class PO
      Returns:
      Access Level

    • getDocumentInfo

      public String getDocumentInfo()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get Document Info
      Specified by:
      getDocumentInfo in interface DocAction
      Returns:
      document info (untranslated)

    • createPDF

      public File createPDF()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create PDF
      Specified by:
      createPDF in interface DocAction
      Returns:
      File or null

    • createPDF

      public File createPDF(File file)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create PDF file
      Parameters:
      file - output file
      Returns:
      file if success

    • processIt

      public boolean processIt(String processAction)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Process document
      Specified by:
      processIt in interface DocAction
      Parameters:
      processAction - document action
      Returns:
      true if performed

    • unlockIt

      public boolean unlockIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Unlock Document.
      Specified by:
      unlockIt in interface DocAction
      Returns:
      true if success

    • invalidateIt

      public boolean invalidateIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Invalidate Document
      Specified by:
      invalidateIt in interface DocAction
      Returns:
      true if success

    • prepareIt

      public String prepareIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Prepare Document
      Specified by:
      prepareIt in interface DocAction
      Returns:
      new status (In Progress or Invalid)

    • approveIt

      public boolean approveIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Approve Document
      Specified by:
      approveIt in interface DocAction
      Returns:
      true if success

    • rejectIt

      public boolean rejectIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reject Approval
      Specified by:
      rejectIt in interface DocAction
      Returns:
      true if success

    • completeIt

      public String completeIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Complete Document
      Specified by:
      completeIt in interface DocAction
      Returns:
      new status (Complete, In Progress, Invalid, Waiting ..)

    • voidIt

      public boolean voidIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Void Document. Same as Close.
      Specified by:
      voidIt in interface DocAction
      Returns:
      true if success

    • closeIt

      public boolean closeIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Close Document. Cancel not delivered Qunatities
      Specified by:
      closeIt in interface DocAction
      Returns:
      true if success

    • reverseCorrectIt

      public boolean reverseCorrectIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reverse Correction
      Specified by:
      reverseCorrectIt in interface DocAction
      Returns:
      true if success

    • reverseAccrualIt

      public boolean reverseAccrualIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Reverse Accrual - none
      Specified by:
      reverseAccrualIt in interface DocAction
      Returns:
      true if success

    • reActivateIt

      public boolean reActivateIt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Re-activate
      Specified by:
      reActivateIt in interface DocAction
      Returns:
      true if success

    • getSummary

      public String getSummary()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get Summary
      Specified by:
      getSummary in interface DocAction
      Returns:
      Summary of Document

    • getDocumentNo

      public String getDocumentNo()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get Document no
      Specified by:
      getDocumentNo in interface DocAction
      Returns:
      Document No

    • getProcessMsg

      public String getProcessMsg()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get Process Message
      Specified by:
      getProcessMsg in interface DocAction
      Returns:
      clear text error message

    • getDoc_User_ID

      public int getDoc_User_ID()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get Document Owner (Responsible)
      Specified by:
      getDoc_User_ID in interface DocAction
      Returns:
      AD_User_ID

    • getApprovalAmt

      public BigDecimal getApprovalAmt()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get Document Approval Amount
      Specified by:
      getApprovalAmt in interface DocAction
      Returns:
      amount

    • getC_Currency_ID

      public int getC_Currency_ID()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get Document Currency
      Specified by:
      getC_Currency_ID in interface DocAction
      Returns:
      C_Currency_ID

    • setDocStatus

      public void setDocStatus(String newStatus)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set Doc Status
      Specified by:
      setDocStatus in interface DocAction
      Parameters:
      newStatus - status

    • getDocStatus

      public String getDocStatus()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get Doc Status
      Specified by:
      getDocStatus in interface DocAction
      Returns:
      doc status

    • getDocAction

      public String getDocAction()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get Doc Action
      Specified by:
      getDocAction in interface DocAction
      Returns:
      doc action

    • save

      public boolean save()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Save
      Specified by:
      save in interface DocAction
      Overrides:
      save in class PO
      Returns:
      true if saved