Package org.compiere.process

Class ProcessInfo

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    WProcessInfo
    public class ProcessInfo
extends Object
implements Serializable
    Process Information (Value Object)
    Version:
    $Id: ProcessInfo.java,v 1.2 2006/07/30 00:54:44 jjanke Exp $
    Author:
    Jorg Janke, victor.perez@e-evolution.com see FR 1906632 https://sourceforge.net/p/adempiere/feature-requests/382/
    See Also:
    Serialized Form

    • Constructor Detail

      • ProcessInfo

        public ProcessInfo​(String Title,
                   int AD_Process_ID,
                   int Table_ID,
                   int Record_ID)
        Constructor
        Parameters:
        Title - Title
        AD_Process_ID - AD_Process_ID
        Table_ID - AD_Table_ID
        Record_ID - Record_ID

      • ProcessInfo

        public ProcessInfo​(String Title,
                   int AD_Process_ID)
        Constructor
        Parameters:
        Title - Title
        AD_Process_ID - AD_Process_ID

    • Method Detail

      • getLanguageID

        public int getLanguageID()

      • setLanguageID

        public void setLanguageID​(int languageID)

      • getReportType

        public String getReportType()

      • setReportType

        public void setReportType​(String reportType)

      • setIsSummary

        public void setIsSummary​(boolean isSummary)

      • isSummary

        public boolean isSummary()

      • toString

        public String toString()
        String representation
        Overrides:
        toString in class Object
        Returns:
        String representation

      • setSummary

        public void setSummary​(String summary)
        Set Summary
        Parameters:
        summary - summary (will be translated)

      • getSummary

        public String getSummary()
        Method getSummary
        Returns:
        String

      • setSummary

        public void setSummary​(String translatedSummary,
                       boolean error)
        Method setSummary
        Parameters:
        translatedSummary - String
        error - boolean

      • addSummary

        public void addSummary​(String additionalSummary)
        Method addSummary
        Parameters:
        additionalSummary - String

      • setError

        public void setError​(boolean error)
        Method setError
        Parameters:
        error - boolean

      • isError

        public boolean isError()
        Method isError
        Returns:
        boolean

      • setIsBatch

        public void setIsBatch​(boolean batch)
        Batch
        Parameters:
        batch - true if batch processing

      • isBatch

        public boolean isBatch()
        Batch - i.e. UI not blocked
        Returns:
        boolean

      • setIsTimeout

        public void setIsTimeout​(boolean timeout)
        Timeout
        Parameters:
        timeout - true still running

      • isTimeout

        public boolean isTimeout()
        Timeout - i.e process did not complete
        Returns:
        boolean

      • getLogInfo

        public String getLogInfo​(boolean html)
        Set Log of Process. 
          - Translated Process Message
  - List of log entries
      Date - Number - Msg
        Parameters:
        html - if true with HTML markup
        Returns:
        Log Info

      • getLogInfo

        public String getLogInfo()
        Get ASCII Log Info
        Returns:
        Log Info

      • getAD_PInstance_ID

        public int getAD_PInstance_ID()
        Method getAD_PInstance_ID
        Returns:
        int

      • setAD_PInstance_ID

        public void setAD_PInstance_ID​(int AD_PInstance_ID)
        Method setAD_PInstance_ID
        Parameters:
        AD_PInstance_ID - int

      • getAD_InfoWindow_ID

        public int getAD_InfoWindow_ID()
        Returns:
        int

      • setAD_InfoWindow_ID

        public void setAD_InfoWindow_ID​(int infoWindowID)
        Parameters:
        infoWindowID - int

      • getAD_Process_ID

        public int getAD_Process_ID()
        Method getAD_Process_ID
        Returns:
        int

      • setAD_Process_ID

        public void setAD_Process_ID​(int AD_Process_ID)
        Method setAD_Process_ID
        Parameters:
        AD_Process_ID - int

      • getClassName

        public String getClassName()
        Method getClassName
        Returns:
        String or null

      • setClassName

        public void setClassName​(String ClassName)
        Method setClassName
        Parameters:
        ClassName - String

      • getTransientObject

        public Object getTransientObject()
        Method getTransientObject
        Returns:
        Object

      • setTransientObject

        public void setTransientObject​(Object TransientObject)
        Method setTransientObject
        Parameters:
        TransientObject - Object

      • getSerializableObject

        public Serializable getSerializableObject()
        Method getSerializableObject
        Returns:
        Serializable

      • setSerializableObject

        public void setSerializableObject​(Serializable SerializableObject)
        Method setSerializableObject
        Parameters:
        SerializableObject - Serializable

      • getEstSeconds

        public int getEstSeconds()
        Method getEstSeconds
        Returns:
        int

      • setEstSeconds

        public void setEstSeconds​(int EstSeconds)
        Method setEstSeconds
        Parameters:
        EstSeconds - int

      • getTable_ID

        public int getTable_ID()
        Method getTable_ID
        Returns:
        int

      • setTable_ID

        public void setTable_ID​(int AD_Table_ID)
        Method setTable_ID
        Parameters:
        AD_Table_ID - int

      • getRecord_ID

        public int getRecord_ID()
        Method getRecord_ID
        Returns:
        int

      • setRecord_ID

        public void setRecord_ID​(int Record_ID)
        Method setRecord_ID
        Parameters:
        Record_ID - int

      • getTitle

        public String getTitle()
        Method getTitle
        Returns:
        String

      • setTitle

        public void setTitle​(String Title)
        Method setTitle
        Parameters:
        Title - String

      • setAD_Client_ID

        public void setAD_Client_ID​(int AD_Client_ID)
        Method setAD_Client_ID
        Parameters:
        AD_Client_ID - int

      • getAD_Client_ID

        public Integer getAD_Client_ID()
        Method getAD_Client_ID
        Returns:
        Integer

      • setAD_User_ID

        public void setAD_User_ID​(int AD_User_ID)
        Method setAD_User_ID
        Parameters:
        AD_User_ID - int

      • getAD_User_ID

        public Integer getAD_User_ID()
        Method getAD_User_ID
        Returns:
        Integer

      • getParameter

        public ProcessInfoParameter[] getParameter()
        Get Parameter
        Returns:
        Parameter Array

      • setParameter

        public void setParameter​(ProcessInfoParameter[] parameter)
        Set Parameter
        Parameters:
        parameter - Parameter Array

      • addLog

        public void addLog​(int Log_ID,
                   int P_ID,
                   Timestamp P_Date,
                   BigDecimal P_Number,
                   String P_Msg,
                   int tableId,
                   int recordId)

      • addLog

        public void addLog​(int P_ID,
                   Timestamp P_Date,
                   BigDecimal P_Number,
                   String P_Msg,
                   int tableId,
                   int recordId)

      • addLog

        public void addLog​(int Log_ID,
                   int P_ID,
                   Timestamp P_Date,
                   BigDecimal P_Number,
                   String P_Msg)
        Add to Log
        Parameters:
        Log_ID - Log ID
        P_ID - Process ID
        P_Date - Process Date
        P_Number - Process Number
        P_Msg - Process Message

      • addLog

        public void addLog​(int P_ID,
                   Timestamp P_Date,
                   BigDecimal P_Number,
                   String P_Msg)
        Add to Log
        Parameters:
        P_ID - Process ID
        P_Date - Process Date
        P_Number - Process Number
        P_Msg - Process Message

      • addLog

        public void addLog​(ProcessInfoLog logEntry)
        Add to Log
        Parameters:
        logEntry - log entry

      • getLogs

        public ProcessInfoLog[] getLogs()
        Method getLogs
        Returns:
        ProcessInfoLog[]

      • getIDs

        public int[] getIDs()
        Method getIDs
        Returns:
        int[]

      • setLogList

        public void setLogList​(ArrayList<ProcessInfoLog> logs)
        Method setLogList
        Parameters:
        logs - ArrayList

      • getTransactionName

        public String getTransactionName()
        Get transaction name for this process
        Returns:
        String

      • getAD_Process_UU

        public String getAD_Process_UU()

      • setAD_Process_UU

        public void setAD_Process_UU​(String AD_Process_UU)

      • setTransactionName

        public void setTransactionName​(String trxName)
        Set transaction name from this process
        Parameters:
        trxName -

      • setPrintPreview

        public void setPrintPreview​(boolean b)
        Set print preview flag, only relevant if this is a reporting process
        Parameters:
        b -

      • isPrintPreview

        public boolean isPrintPreview()
        Is print preview instead of direct print ? Only relevant if this is a reporting process
        Returns:
        boolean

      • isReportingProcess

        public boolean isReportingProcess()
        Is this a reporting process ?
        Returns:
        boolean

      • setReportingProcess

        public void setReportingProcess​(boolean f)
        Set is this a reporting process
        Parameters:
        f -

      • setPDFReport

        public void setPDFReport​(File f)
        Set PDF file generate to Jasper Report
        Parameters:
        f - PDF File

      • getPDFReport

        public File getPDFReport()
        Get PDF file generate to Jasper Report

      • isExport

        public boolean isExport()
        Is this a export or print process?
        Returns:

      • setExport

        public void setExport​(boolean export)
        Set Export
        Parameters:
        export -

      • getExportFileExtension

        public String getExportFileExtension()
        Get Export File Extension

      • setExportFileExtension

        public void setExportFileExtension​(String exportFileExtension)
        Set Export File Extension
        Parameters:
        exportFileExtension -

      • getExportFile

        public File getExportFile()
        Get Export File
        Returns:

      • setExportFile

        public void setExportFile​(File exportFile)
        Set Export File
        Parameters:
        exportFile -

      • setRecord_IDs

        public void setRecord_IDs​(List<Integer> Record_IDs)

      • setRowCount

        public void setRowCount​(int rowCount)

      • getRowCount

        public int getRowCount()

      • setPO

        public void setPO​(PO po)

      • getPO

        public PO getPO()

      • getPDFFileName

        public String getPDFFileName()

      • setPDFFileName

        public void setPDFFileName​(String fileName)

      • isProcessRunning

        public boolean isProcessRunning​(MPInstancePara[] params)
        Validates to inform a user running again a process that is already in execution.
        Returns:
        true if the same process is already running

      • setProcessUI

        public void setProcessUI​(IProcessUI processUI)