org.compiere.esb
Class GwtServer

java.lang.Object
  org.compiere.esb.GwtServer

public class GwtServer
extends Object

GWT Server Implementation. You maintain one instance per User

Version:

$Id$

Author:

Jorg Janke

Constructor Summary

GwtServer()
Gwt Server

Method Summary

void	copyQueryResults(int sourceID, int destID)
ChangeVO	deleteRow(int windowNo, int AD_Tab_ID, int queryResultID, int relRowNo) Delete existing Row
Boolean	deleteSavedSearch(int tab_ID, String savedSearchName)
void	disposeWindow(ArrayList<Integer> resultIDs) Release Results
int	executeQuery(int AD_Tab_ID, QueryVO queryVO, HashMap<String,String> context, int queryResultID) Execute Query for Tab
ChangeVO	fieldChanged(int windowNo, int AD_Field_ID, int AD_Tab_ID, String oldValue, String newValue, Map<String,String> context) Field Changed
CContext	getContext() Returns the context associated with this GwtServer
UIField	getField(int AD_Field_ID, int windowNo) Get Field
Locale	getLocale() Get Locale
Login	getLogin() Get Login
ArrayList<NamePair>	getLookupData(int windowNo, int AD_Field_ID, Map<String,String> context, boolean refresh) Get Lookup Data for Field in context
ArrayList<NamePair>	getLookupValueDirect(int AD_Field_ID, ArrayList<String> keyValues, boolean cache) Get Field Lookup Value Direct
ArrayList<String>	getLookupValueOnlyDirect(int AD_Field_ID, ArrayList<String> keyValues, boolean cache) Get Field Lookup Value Direct
ArrayList<CTreeNode>	getMenuCreateNew() Get Menu tree that directly enter "create new" mode
ArrayList<CTreeNode>	getMenuFavorites() Get Menu favorites for a user
ArrayList<CTreeNode>	getMenuTree() Get Menu
int	getNotes() Get number of open Notes
int	getRequests() Get Number of open Requests
String[][]	getResults(int queryResultID, int fromRow, int noRows) Retrieve results for Tab.
UITab	getTab(int AD_Tab_ID) Get Tab with ID
String[][]	getTabSearchResults(int searchResultID, int rowCount)
UIWindow	getWindow(int windowNo, int AD_Window_ID, int AD_Menu_ID) Get Window in default context based on Role
int	getZoomWindowNO()
ChangeVO	insertRow(int windowNo, int AD_Tab_ID, int queryResultID, int curRow, Map<String,String> context) Save (Insert new) Row of Tab
void	logout(boolean expired) Logout
ChangeVO	newRow(int windowNo, int AD_Tab_ID, Map<String,String> context) Create new Row with Default values.
ChangeVO	refreshRow(int windowNo, int AD_Tab_ID, int queryResultID, int relRowNo, Map<String,String> context) Refresh current row of Tab
void	releaseResults() Release All Results
String[]	requery(int queryResultID, int row) Execute Query for Tab.
static void	resetWinDefCache()
Boolean	savePreferences(Map<String,String> ctx)
int	searchTabResults(int WindowNo, int AD_Tab_ID, int queryResultID, int searchResultID, String query, int rowCount)
void	setLocale(Locale loc) Set Locale
void	sortResults(int WindowNo, int AD_Tab_ID, int AD_Field_ID, int queryResultID, boolean ascending)
boolean	updateCreateNew(boolean add, int Node_ID) Make create new add/remove persistent ("bar" in swing client)
boolean	updateCreateNew(List<Integer> menuIDs)
boolean	updateFavorites(boolean add, int Node_ID) Make Favorites add/remove persistent ("bar" in swing client)
boolean	updateFavorites(List<Integer> menuIDs) Update of user favorites for a user with specified ordering for favorites
ChangeVO	updateRow(int windowNo, int AD_Tab_ID, int queryResultID, int relRowNo, Map<String,String> context) Save (Update existing) Row of Tab
ChangeVO	updateRow(int windowNo, int AD_Tab_ID, int queryResultID, int relRowNo, Map<String,String> context, boolean force)

Methods inherited from class java.lang.Object

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

Constructor Detail

GwtServer

public GwtServer()

Gwt Server

Method Detail

resetWinDefCache

public static void resetWinDefCache()

getLogin

public Login getLogin()

Get Login

Returns:

login

getContext

public CContext getContext()

Returns the context associated with this GwtServer

Returns:

context

setLocale

public void setLocale(Locale loc)

Set Locale

Parameters:

loc - locale (from login)

logout

public void logout(boolean expired)

Logout

Parameters:

expired - expire

getLocale

public Locale getLocale()

Get Locale

Returns:

Locale

getMenuTree

public ArrayList<CTreeNode> getMenuTree()

Get Menu

Returns:

menu as array list

getMenuFavorites

public ArrayList<CTreeNode> getMenuFavorites()

Get Menu favorites for a user

Returns:

menu as array list

getMenuCreateNew

public ArrayList<CTreeNode> getMenuCreateNew()

Get Menu tree that directly enter "create new" mode

Returns:

menu as array list

updateFavorites

public boolean updateFavorites(boolean add,
                               int Node_ID)

Make Favorites add/remove persistent ("bar" in swing client)

Parameters:

add - true if add - otherwise remove

Node_ID - Node ID

Returns:

true if updated

updateFavorites

public boolean updateFavorites(List<Integer> menuIDs)

Update of user favorites for a user with specified ordering for favorites

Parameters:

menuIDs - List ordered list of menuIDs to put in the tree

Returns:

true if updated

updateCreateNew

public boolean updateCreateNew(boolean add,
                               int Node_ID)

Make create new add/remove persistent ("bar" in swing client)

Parameters:

add - true if add - otherwise remove

Node_ID - Node ID

Returns:

true if updated

updateCreateNew

public boolean updateCreateNew(List<Integer> menuIDs)

getRequests

public int getRequests()

Get Number of open Requests

Returns:

number of requests

getNotes

public int getNotes()

Get number of open Notes

Returns:

Number of notes

getWindow

public UIWindow getWindow(int windowNo,
                          int AD_Window_ID,
                          int AD_Menu_ID)

Get Window in default context based on Role

Parameters:

windowNo - relative window

AD_Window_ID - window

AD_Menu_ID - menu

Returns:

WindowVO or null

getTab

public UITab getTab(int AD_Tab_ID)

Get Tab with ID

Parameters:

AD_Tab_ID -

Returns:

tab or null

getField

public UIField getField(int AD_Field_ID,
                        int windowNo)

Get Field

Parameters:

AD_Field_ID - id

windowNo - relative windowNo

Returns:

field or null

executeQuery

public int executeQuery(int AD_Tab_ID,
                        QueryVO queryVO,
                        HashMap<String,String> context,
                        int queryResultID)

Execute Query for Tab

Parameters:

AD_Tab_ID - tab

queryVO - optional query

context - record context for link columns and other variables

queryResultID - stored query identifier provided by client

Returns:

number of records or -1 if error

getResults

public String[][] getResults(int queryResultID,
                             int fromRow,
                             int noRows)

Retrieve results for Tab. If the from/to range does not exist, it returns existing rows

Parameters:

queryResultID - stored query identifier provided by client

fromRow - from row first is 0

toRow - to row including

Returns:

array of rows of array of field values or null if error. You get the columnNames via String[] columns = uiTab.getColumnNames();

sortResults

public void sortResults(int WindowNo,
                        int AD_Tab_ID,
                        int AD_Field_ID,
                        int queryResultID,
                        boolean ascending)

searchTabResults

public int searchTabResults(int WindowNo,
                            int AD_Tab_ID,
                            int queryResultID,
                            int searchResultID,
                            String query,
                            int rowCount)

copyQueryResults

public void copyQueryResults(int sourceID,
                             int destID)

getTabSearchResults

public String[][] getTabSearchResults(int searchResultID,
                                      int rowCount)

requery

public String[] requery(int queryResultID,
                        int row)

Execute Query for Tab. If the from/to range does not exist, it returns existing rows

Parameters:

queryResultID - stored query identifier provided by client

row - row number first is 0

Returns:

array of rows of array of field values or null if error. You get the columnNames via String[] columns = uiTab.getColumnNames();

releaseResults

public void releaseResults()

Release All Results

disposeWindow

public void disposeWindow(ArrayList<Integer> resultIDs)

Release Results

Parameters:

queryResultID - stored query identifier provided by client

newRow

public ChangeVO newRow(int windowNo,
                       int AD_Tab_ID,
                       Map<String,String> context)

Create new Row with Default values. The new Row is not saved in Results

Parameters:

windowNo - relative window

AD_Tab_ID - tab

context - record context for parent columns and other variables

Returns:

array of field values or null if error. You get the columnNames via String[] columns = uiTab.getColumnNames();

refreshRow

public ChangeVO refreshRow(int windowNo,
                           int AD_Tab_ID,
                           int queryResultID,
                           int relRowNo,
                           Map<String,String> context)

Refresh current row of Tab

Parameters:

windowNo - relative window

AD_Tab_ID - tab

relRowNo - relative row number in results

context - current (relevant) context of new row

Returns:

error message or null

updateRow

public ChangeVO updateRow(int windowNo,
                          int AD_Tab_ID,
                          int queryResultID,
                          int relRowNo,
                          Map<String,String> context,
                          boolean force)

updateRow

public ChangeVO updateRow(int windowNo,
                          int AD_Tab_ID,
                          int queryResultID,
                          int relRowNo,
                          Map<String,String> context)

Save (Update existing) Row of Tab

Parameters:

windowNo - relative window

AD_Tab_ID - tab

relRowNo - relative row number in results

context - current (relevant) context of new row

Returns:

error message or null

insertRow

public ChangeVO insertRow(int windowNo,
                          int AD_Tab_ID,
                          int queryResultID,
                          int curRow,
                          Map<String,String> context)

Save (Insert new) Row of Tab

Parameters:

windowNo - relative window

AD_Tab_ID - tab

curRow - insert after relative row number in results

context - current (relevant) context of new row

Returns:

error message or null

deleteRow

public ChangeVO deleteRow(int windowNo,
                          int AD_Tab_ID,
                          int queryResultID,
                          int relRowNo)

Delete existing Row

Parameters:

windowNo - relative window

AD_Tab_ID - tab

relRowNo - relative row number in results

Returns:

error message or null

fieldChanged

public ChangeVO fieldChanged(int windowNo,
                             int AD_Field_ID,
                             int AD_Tab_ID,
                             String oldValue,
                             String newValue,
                             Map<String,String> context)

Field Changed

Parameters:

windowNo - relative window

AD_Field_ID - field

AD_Tab_ID - tab

oldValue - old field value

newValue - new field value

context - record context

Returns:

Field Change VO

getLookupValueDirect

public ArrayList<NamePair> getLookupValueDirect(int AD_Field_ID,
                                                ArrayList<String> keyValues,
                                                boolean cache)

Get Field Lookup Value Direct

Parameters:

windowNo - Window

AD_Field_ID -

keyValues - array of id values

cache -

Returns:

list of display values

getLookupValueOnlyDirect

public ArrayList<String> getLookupValueOnlyDirect(int AD_Field_ID,
                                                  ArrayList<String> keyValues,
                                                  boolean cache)

Get Field Lookup Value Direct

Parameters:

windowNo - Window

AD_Field_ID -

keyValues - array of id values

cache -

Returns:

list of display values

getLookupData

public ArrayList<NamePair> getLookupData(int windowNo,
                                         int AD_Field_ID,
                                         Map<String,String> context,
                                         boolean refresh)

Get Lookup Data for Field in context

Parameters:

AD_Field_ID - field

context - context

refresh - requery

Returns:

lookup pair array

getZoomWindowNO

public int getZoomWindowNO()

savePreferences

public Boolean savePreferences(Map<String,String> ctx)

deleteSavedSearch

public Boolean deleteSavedSearch(int tab_ID,
                                 String savedSearchName)