org.compiere.process
Class ProcessInfo

java.lang.Object
  org.compiere.process.ProcessInfo

All Implemented Interfaces:

Serializable

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 Also:

1906632 http://sourceforge.net/tracker/?func=detail&atid=879335&aid=1906632&group_id=176962, Serialized Form

Constructor Summary

ProcessInfo(String Title, int AD_Process_ID)
Constructor

ProcessInfo(String Title, int AD_Process_ID, int Table_ID, int Record_ID)
Constructor

Method Summary

void	addLog(int Log_ID, int P_ID, Timestamp P_Date, BigDecimal P_Number, String P_Msg) Add to Log
void	addLog(int P_ID, Timestamp P_Date, BigDecimal P_Number, String P_Msg) Add to Log
void	addLog(ProcessInfoLog logEntry) Add to Log
void	addSummary(String additionalSummary) Method addSummary
Integer	getAD_Client_ID() Method getAD_Client_ID
int	getAD_PInstance_ID() Method getAD_PInstance_ID
int	getAD_Process_ID() Method getAD_Process_ID
Integer	getAD_User_ID() Method getAD_User_ID
String	getClassName() Method getClassName
int	getEstSeconds() Method getEstSeconds
int[]	getIDs() Method getIDs
String	getLogInfo() Get ASCII Log Info
String	getLogInfo(boolean html) Set Log of Process.
ArrayList	getLogList() Method getLogList
ProcessInfoLog[]	getLogs() Method getLogs
ProcessInfoParameter[]	getParameter() Get Parameter
File	getPDFReport() Get PDF file generate to Jasper Report
int	getRecord_ID() Method getRecord_ID
Serializable	getSerializableObject() Method getSerializableObject
String	getSummary() Method getSummary
int	getTable_ID() Method getTable_ID
String	getTitle() Method getTitle
String	getTransactionName() Get transaction name for this process
Object	getTransientObject() Method getTransientObject
boolean	isBatch() Batch - i.e.
boolean	isError() Method isError
boolean	isPrintPreview() Is print preview instead of direct print ?
boolean	isReportingProcess() Is this a reporting process ?
boolean	isTimeout() Timeout - i.e process did not complete
void	setAD_Client_ID(int AD_Client_ID) Method setAD_Client_ID
void	setAD_PInstance_ID(int AD_PInstance_ID) Method setAD_PInstance_ID
void	setAD_Process_ID(int AD_Process_ID) Method setAD_Process_ID
void	setAD_User_ID(int AD_User_ID) Method setAD_User_ID
void	setClassName(String ClassName) Method setClassName
void	setError(boolean error) Method setError
void	setEstSeconds(int EstSeconds) Method setEstSeconds
void	setIsBatch(boolean batch) Batch
void	setIsTimeout(boolean timeout) Timeout
void	setLogList(ArrayList<ProcessInfoLog> logs) Method setLogList
void	setParameter(ProcessInfoParameter[] parameter) Set Parameter
void	setPDFReport(File f) Set PDF file generate to Jasper Report
void	setPrintPreview(boolean b) Set print preview flag, only relevant if this is a reporting process
void	setRecord_ID(int Record_ID) Method setRecord_ID
void	setReportingProcess(boolean f) Set is this a reporting process
void	setSerializableObject(Serializable SerializableObject) Method setSerializableObject
void	setSummary(String summary) Set Summary
void	setSummary(String translatedSummary, boolean error) Method setSummary
void	setTable_ID(int AD_Table_ID) Method setTable_ID
void	setTitle(String Title) Method setTitle
void	setTransactionName(String trxName) Set transaction name from this process
void	setTransientObject(Object TransientObject) Method setTransientObject
String	toString() String representation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

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[]

getLogList

public ArrayList getLogList()

Method getLogList

Returns:

ArrayList

setLogList

public void setLogList(ArrayList<ProcessInfoLog> logs)

Method setLogList

Parameters:

logs - ArrayList

getTransactionName

public String getTransactionName()

Get transaction name for this process

Returns:

String

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:

PDF - File

getPDFReport

public File getPDFReport()

Get PDF file generate to Jasper Report

Parameters:

f -