org.compiere.vos
Class ResponseVO

java.lang.Object
  org.compiere.vos.ResponseVO

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ChangeVO, PreloadVO, WindowVO, ZoomTargetVO

public class ResponseVO
extends Object
implements Serializable

Author:

dzhao A common interface for passing back error, warning and success messages from server side AsyncCommand will first intercept the message and display warning/error messages in a modal dialog box

See Also:

Serialized Form

Nested Class Summary

static class

ResponseVO.Message

Field Summary

String[]	commands
protected boolean	hasError
protected boolean	hasResults
protected boolean	hasWarning
protected ArrayList<ResponseVO.Message>	messages usually there are only one message
protected HashMap<String,String>	params
protected boolean	passThrough
int	targetWinCmd

Constructor Summary

ResponseVO()

Method Summary

void	addError(String message) Add clear text error message
protected void	addParam(String var, String v)
void	addSuccess(String message) Add clear text success message
void	addWarning(String message) Add clear text warning message
ArrayList<ResponseVO.Message>	getMessages() usually there are only one message
String	getParam(String var)
int	getProcessID()
boolean	hasError()
boolean	hasResults()
boolean	hasWarning()
boolean	isPassThrough()
boolean	isRefreshAll()
void	setParams(HashMap<String,String> params)
void	setPassThrough(boolean passThrough)
void	setProcessID(int processID)
void	setRefreshAll(boolean refresh)
void	showResults(boolean hasResults) Normally success results are not shown in a dialog.
String	toDisplay()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

messages

protected ArrayList<ResponseVO.Message> messages

usually there are only one message

hasError

protected boolean hasError

hasWarning

protected boolean hasWarning

hasResults

protected boolean hasResults

passThrough

protected boolean passThrough

params

protected HashMap<String,String> params

commands

public String[] commands

targetWinCmd

public int targetWinCmd

Constructor Detail

ResponseVO

public ResponseVO()

Method Detail

addParam

protected void addParam(String var,
                        String v)

getParam

public String getParam(String var)

getProcessID

public int getProcessID()

setProcessID

public void setProcessID(int processID)

isRefreshAll

public boolean isRefreshAll()

setRefreshAll

public void setRefreshAll(boolean refresh)

addError

public void addError(String message)

Add clear text error message

Parameters:

message - clear text message

addWarning

public void addWarning(String message)

Add clear text warning message

Parameters:

message - clear text message

addSuccess

public void addSuccess(String message)

Add clear text success message

Parameters:

message - clear text message

getMessages

public ArrayList<ResponseVO.Message> getMessages()

usually there are only one message

hasError

public boolean hasError()

hasWarning

public boolean hasWarning()

hasResults

public boolean hasResults()

showResults

public void showResults(boolean hasResults)

Normally success results are not shown in a dialog.

Parameters:

hasResults -

toString

public String toString()

Overrides:

toString in class Object

toDisplay

public String toDisplay()

setParams

public void setParams(HashMap<String,String> params)

isPassThrough

public boolean isPassThrough()

setPassThrough

public void setPassThrough(boolean passThrough)