org.compiere.vos
Class ChangeVO

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

All Implemented Interfaces:

Serializable

public class ChangeVO
extends ResponseVO

Consequences of - Field Value Changes - New Row - Save (Update/Insert) Row

Version:

$Id$

Author:

Jorg Janke

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.compiere.vos.ResponseVO

ResponseVO.Message

Field Summary

HashMap<String,String>	changedComponents Components that are changed now only support display/non-display flag
HashMap<String,String>	changedContext Changed or New Window Context Map
HashMap<String,ArrayList<NamePair>>	changedDropDowns Changed Drop Down Lists Map< FieldName,ArrayList >
HashMap<String,String>	changedFields Changed or New Values Map< ColumnName,ColumnValue >
String	newConfirmedFieldValue New Confirmed Value for Field Changes
WindowVO	newWindowVO Populate this to completely replace the WindowVO of the currently open window
HashMap<Integer,QueryVO>	queryComponents The map of component IDs to QueryVOs.
String[]	rowData Row Data
boolean	updateCurrentRow If this is set, the row represented by the current WindowCtx object will be updated.
boolean	updateWindowVO Set this to true to request the client UI to re-render the entire window.

Fields inherited from class org.compiere.vos.ResponseVO

commands, hasError, hasResults, hasWarning, messages, params, passThrough, targetWinCmd

Constructor Summary

ChangeVO()
Change VO

ChangeVO(boolean error, String message)
Change VO Error/Info Message

ChangeVO(String message)
Change VO Info Message

Method Summary

void	addAll(ChangeVO add) Add all values for change vo
String	addChangedComponent(String tableName, String value) Add Changed Component
ArrayList<NamePair>	addChangedDropDown(String columnName, ArrayList<NamePair> data) Add Changed Drop Down Values
String	addChangedValue(String columnName, boolean value) Add Changed Value
String	addChangedValue(String columnName, byte[] value) Add Changed Value
String	addChangedValue(String columnName, int value) Add Changed Value
String	addChangedValue(String columnName, Object value) Add Changed Value
void	addContextAll(Ctx ctx, int windowNo) Set Context - merge changedContext to Ctx
ChangeVO	cleanup() Cleanup Values
void	mergeTo(HashMap<String,String> to)
String	setContext(Ctx ctx, int windowNo, String columnName, boolean value) Set Context - add to changed Context
String	setContext(Ctx ctx, int windowNo, String columnName, int value) Set Context - add to changed Context
String	setContext(Ctx ctx, int windowNo, String columnName, Number value) Set Context - add to changed Context
String	setContext(Ctx ctx, int windowNo, String columnName, String value) Set Context - add to changed Context
String	toString() String Representation

Methods inherited from class org.compiere.vos.ResponseVO

addError, addParam, addSuccess, addWarning, getMessages, getParam, getProcessID, hasError, hasResults, hasWarning, isPassThrough, isRefreshAll, setParams, setPassThrough, setProcessID, setRefreshAll, showResults, toDisplay

Methods inherited from class java.lang.Object

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

Field Detail

newConfirmedFieldValue

public String newConfirmedFieldValue

New Confirmed Value for Field Changes

changedFields

public HashMap<String,String> changedFields

Changed or New Values Map< ColumnName,ColumnValue >

changedDropDowns

public HashMap<String,ArrayList<NamePair>> changedDropDowns

Changed Drop Down Lists Map< FieldName,ArrayList >

changedContext

public HashMap<String,String> changedContext

Changed or New Window Context Map

changedComponents

public HashMap<String,String> changedComponents

Components that are changed now only support display/non-display flag

rowData

public String[] rowData

Row Data

queryComponents

public HashMap<Integer,QueryVO> queryComponents

The map of component IDs to QueryVOs. If a QueryVO is present for a component, a query will be run against that component with the provided QueryVO.

updateCurrentRow

public boolean updateCurrentRow

If this is set, the row represented by the current WindowCtx object will be updated.

updateWindowVO

public boolean updateWindowVO

Set this to true to request the client UI to re-render the entire window.

newWindowVO

public WindowVO newWindowVO

Populate this to completely replace the WindowVO of the currently open window

Constructor Detail

ChangeVO

public ChangeVO()

Change VO

ChangeVO

public ChangeVO(String message)

Change VO Info Message

Parameters:

error - error flag

message - info message

ChangeVO

public ChangeVO(boolean error,
                String message)

Change VO Error/Info Message

Parameters:

error - error flag

message - Error/Info message

Method Detail

addChangedComponent

public String addChangedComponent(String tableName,
                                  String value)

Add Changed Component

Parameters:

ColumnName - column

value - new value

previous - value or null

addChangedValue

public String addChangedValue(String columnName,
                              Object value)

Add Changed Value

Parameters:

columnName - column

value - new value

previous - value or null

addChangedValue

public String addChangedValue(String columnName,
                              boolean value)

Add Changed Value

Parameters:

columnName - column

value - new value

previous - value or null

addChangedValue

public String addChangedValue(String columnName,
                              int value)

Add Changed Value

Parameters:

columnName - column

value - new value

previous - value or null

addChangedValue

public String addChangedValue(String columnName,
                              byte[] value)

Add Changed Value

Parameters:

columnName - column

value - new value

previous - value or null

addChangedDropDown

public ArrayList<NamePair> addChangedDropDown(String columnName,
                                              ArrayList<NamePair> data)

Add Changed Drop Down Values

Parameters:

columnName - column

data - ArrayList data

previous - value or null

setContext

public String setContext(Ctx ctx,
                         int windowNo,
                         String columnName,
                         String value)

Set Context - add to changed Context

Parameters:

ctx - transitory context

windowNo - window no

columnName - column

value - new value

previous - value or null

setContext

public String setContext(Ctx ctx,
                         int windowNo,
                         String columnName,
                         int value)

Set Context - add to changed Context

Parameters:

ctx - transitory context

windowNo - window no

columnName - column

value - new value

previous - value or null

setContext

public String setContext(Ctx ctx,
                         int windowNo,
                         String columnName,
                         boolean value)

Set Context - add to changed Context

Parameters:

ctx - transitory context

windowNo - window no

columnName - column

value - new value

previous - value or null

setContext

public String setContext(Ctx ctx,
                         int windowNo,
                         String columnName,
                         Number value)

Set Context - add to changed Context

Parameters:

ctx - transitory context

windowNo - window no

columnName - column

value - new value

previous - value or null

addContextAll

public void addContextAll(Ctx ctx,
                          int windowNo)

Set Context - merge changedContext to Ctx

Parameters:

ctx - transitory context

windowNo - window no

previous - value or null

mergeTo

public void mergeTo(HashMap<String,String> to)

addAll

public void addAll(ChangeVO add)

Add all values for change vo

Parameters:

add - change VO to be added

cleanup

public ChangeVO cleanup()

Cleanup Values

Returns:

this

toString

public String toString()

String Representation

Overrides:

toString in class ResponseVO

Returns:

info