org.opensubsystems.patterns.listdata.data
Class ListOptions

java.lang.Object
  extended by org.opensubsystems.patterns.listdata.data.ListOptions
All Implemented Interfaces:
java.io.Serializable

public class ListOptions
extends java.lang.Object
implements java.io.Serializable

This class collects various attributes describing list of data objects to load. It allows to specify what attributes of the data objects to load, what should be the order of data elements, etc. It also provides some placeholders for informations used by GUI to display this list that are not necessary used to load the list, but they needs to be propagated when the list is reloaded or to describe the initial status of the list.

Version:
$Id: ListOptions.java,v 1.24 2007/03/24 08:34:30 bastafidli Exp $
Author:
Julo Legeny
See Also:
Serialized Form
Code reviewer:
Miro Halas
Code reviewed:
1.15 2006/03/14 23:55:38 jlegeny

Field Summary
protected  int[] m_arrFilterableColumnCodes
          List of columns codes which could be used to filter data by the persistance store.
protected  int[] m_arrOrderColumnCodes
          Code of the columns to order by, for each column at the same index is in m_bOrderDirections setup the direction of ordering.
protected  java.lang.String[] m_arrOrderDirections
          Direction of the ordering ASC/DESC.
protected  int[] m_arrRetrieveColumnCodes
          List of columns codes representing data object attributes, which are retrieved from the database.
protected  int[] m_arrShowColumnCodes
          List of columns codes representing data object attributes, which are shown in the list in GUI.
protected  int[] m_arrSortableColumnCodes
          List of columns codes which could be used to sort data by the persistance store.
protected  boolean m_bDistinct
          Load only distinct items.
protected  boolean m_bKeepSelected
          Load also previously selected items even if they are not in the current range of items to load.
protected  ListDefinition m_definition
          Basic definition used for this list.
protected  SimpleRule m_extraFilter
          Filter specifying extra conditions which data has to satisfy.
protected  int m_iActualListSize
          Number of all items in the requested list regardless if only portion of the list is requested or sent.
protected  int m_iActualPage
          1 based actual page number, e.g 1st page of 10 pages.
protected  int m_iBeginPosition
          Position of the first requested/loaded item in list.
protected  int m_iClientOrderCode
          Code of the client column to order the list by on the client.
protected  int m_iDomainId
          Domain ID that will be used for constructing query for getting object list.
protected  int m_iEndPosition
          Position of the last requested/loaded item in list.
protected  int m_iExtraLogicalOperation
          Logical operation used to merge extra filter with the ones from list definition.
protected  int m_iFirstVisibleItem
          Identification of first visible item on the GUI.
protected  int m_iPageSize
          Number of items per page defines how many items are loaded at once.
protected  int m_iParentDataType
          Data type of parent object of the list of data.
protected  int m_iParentId
          ID of parent object of the list of data.
protected  java.lang.Class m_listFactoryClass
          Class representing data factory that implements list factory interface to use to retrieve data for list of data objects TODO: Improve: Since this class is used at many levels it doesn't make much sense to specify data factory to use.
protected  SimpleRule m_securityFilter
          Filter defining what data has user rights to access.
protected  java.lang.String m_strClientOrderDirection
          Type of the client ordering ASC/DESC.
protected  java.lang.String m_strDefinitionId
          String representation of a list definition which should be used to load the list of data objects.
protected  java.lang.String m_strIgnoredItemIDs
          Comma separated list of IDs of items which should not be loaded even though they satisfy filter, extra and security conditions.
protected  java.lang.String m_strMarkedItemIDs
          String of comma separated marked item IDs from the list.
protected  java.lang.String m_strSelectedItemIDs
          String of comma separated selected item IDs from the list.
static int PAGE_SIZE_ALL
          Use this constant when you want to load all items.
 
Constructor Summary
ListOptions(java.lang.Class listFactoryClass)
          Empty list options initialized to default parameters
ListOptions(java.lang.Class listFactoryClass, java.lang.String strDefinitionId, int iPageSize, int iActualListSize, int[] arrOrderColumnCodes, java.lang.String[] arrOrderDirections, int iClientOrderCode, java.lang.String strClientOrderDirection, int iBeginPosition, int iEndPosition, int iActualPage, int iFirstVisibleItem, int iParentDataType, int iParentId, java.lang.String strSelectedItemIds, java.lang.String strMarkedItemIds, int[] arrShowColumnCodes, java.lang.String strIgnoredItemIds, boolean bDistinct, boolean bKeepSelected, int iDomainId)
           
 
Method Summary
 int getAbsolutePageCount()
          Absolute page count is total amount of pages of data independent from the current position in the list.
 int getActualListSize()
           
 int getActualPage()
           
 int getBeginPosition()
           
 int getClientOrderCode()
           
 java.lang.String getClientOrderDirection()
           
 ListDefinition getDefinition()
           
 java.lang.String getDefinitionId()
           
 int getDomainId()
           
 int getEndPosition()
           
 int getExtraConditionAttribute()
          Get attribute of the single extra condition that is part of the extra filter.
 java.lang.String getExtraConditionValue()
          Get value of the single extra condition that is part of the extra filter.
 SimpleRule getExtraFilter()
           
 int getExtraLogicalOperation()
           
 int[] getFilterableColumnCodes()
          Get list of columns codes which could be used to filter data by the persistance store.
 int getFirstVisibleItem()
           
 java.util.List getGoToPages()
          Generate list of pages to which user can jump directly.
 java.lang.String getIgnoredItemIDs()
           
 boolean getIsFirstPage()
          Check if the list is on the first page Used by JSP
 boolean getIsKeepSelectedChecked()
           
 boolean getIsLastPage()
          Check if the list is on the last page Used by JSP
 int getKeepSelected()
           
 java.lang.Class getListFactoryClass()
           
 java.lang.String getMarkedItemIDs()
           
 int[] getOrderColumnCodes()
           
 java.lang.String[] getOrderDirections()
           
 int getPageSize()
           
 int getParentDataType()
           
 int getParentId()
           
 int getRelativePageCount()
          Relative page count is total amount of pages of data relative to the current position in the list since beucase our current position doesn't have to be alligned with page boundaries there might be 1 more page before or after the current position which wouldn't be there otherwise.
 int[] getRetrieveColumnCodes()
          Get list of columns codes which were/should be retrieved from the database.
 SimpleRule getSecurityFilter()
           
 java.lang.String getSelectedItemIDs()
           
 int[] getShowColumnCodes()
           
 int[] getSortableColumnCodes()
          Get list of columns codes which could be used to sort data by the persistance store.
 boolean isDistinct()
           
 void setActualListSize(int iActualListSize)
           
 void setActualPage(int iActualPage)
          Set the page which should be the actual page shown.
 void setBeginPosition(int iBeginPosition)
          Set the begin position which is the position of the first element in the full list of elements.
 void setClientOrderCode(int iClientOrderCode)
           
 void setClientOrderDirection(java.lang.String strClientOrderDirection)
           
 void setDefinition(ListDefinition definition)
           
 void setDefinitionId(java.lang.String strDefinitionId)
           
 void setDistinct(boolean bDistinct)
           
 void setDomainId(int iDomainId)
           
 void setEndPosition(int iEndPosition)
          Set the end position which is the position of the first element in the full list of elements.
 void setExtraFilter(SimpleRule extraFilter, int iExtraLogicalOperation)
           
 void setFilterableColumnCodes(int[] arrFilterableColumnCodes)
          Set llist of columns codes which could be used to filter data by the persistance store.
 void setFirstVisibleItem(int iFirstVisibleItem)
           
 void setIgnoredItemIDs(java.lang.String strIgnoredItems)
          Select IDs of tiems which shouldn't be loaded even through they satisfy other conditions.
 void setKeepSelected(boolean bKeepSelected)
           
 void setMarkedItemIDs(java.lang.String strMarkedItemIDs)
          Set IDs of the items, which are or should be highlighted or otherwise marked on the GUI.
 void setOrdering(int[] arrOrderColumnCodes, java.lang.String[] arrOrderDirections)
           
 void setPageSize(int iPageSize)
           
 void setParentDataType(int iParentDataType)
           
 void setParentId(int iParentId)
           
 void setRetrieveColumnCodes(int[] arrRetrieveColumnCodes)
          Set list of columns codes which were/should be retrieved from the persistance store.
 void setSecurityFilter(SimpleRule securityRule)
           
 void setSelectedItemIDs(java.lang.String strSelectedItems)
          Set IDs of the items, which are or should be selected on the GUI.
 void setShowColumnCodes(int[] arrShowColumnCodes)
           
 void setSortableColumnCodes(int[] arrSortableColumnCodes)
          Set list of columns codes which could be used to sort data by the persistance store.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PAGE_SIZE_ALL

public static final int PAGE_SIZE_ALL
Use this constant when you want to load all items. TODO: Improve: Change this to MAX_INT value so that we can distinguish when we really want all and when we just forgot to initialize variable.

See Also:
Constant Field Values

m_listFactoryClass

protected java.lang.Class m_listFactoryClass
Class representing data factory that implements list factory interface to use to retrieve data for list of data objects TODO: Improve: Since this class is used at many levels it doesn't make much sense to specify data factory to use. It would make more sense to specify data object which should be result in this list and then from there internally determine what is the factory.


m_strDefinitionId

protected java.lang.String m_strDefinitionId
String representation of a list definition which should be used to load the list of data objects. This can be string representation of an ID of a ListDefinition if the list definition should be loaded from a persistence store or a DataObject.NEW_ID if no list definition is specified. The other option is that this value can be a string representation of the entire list definition, which is then read and parsed from this variable.


m_arrOrderColumnCodes

protected int[] m_arrOrderColumnCodes
Code of the columns to order by, for each column at the same index is in m_bOrderDirections setup the direction of ordering.


m_arrOrderDirections

protected java.lang.String[] m_arrOrderDirections
Direction of the ordering ASC/DESC. See ORDER_XXX constants in the ListDefinition. The constant coresponds to the column code in m_iOrderColumnsCodes.


m_iPageSize

protected int m_iPageSize
Number of items per page defines how many items are loaded at once.


m_iBeginPosition

protected int m_iBeginPosition
Position of the first requested/loaded item in list.


m_iEndPosition

protected int m_iEndPosition
Position of the last requested/loaded item in list.


m_iActualPage

protected int m_iActualPage
1 based actual page number, e.g 1st page of 10 pages.


m_iActualListSize

protected int m_iActualListSize
Number of all items in the requested list regardless if only portion of the list is requested or sent. This is sent only from backend to GUI.


m_strSelectedItemIDs

protected java.lang.String m_strSelectedItemIDs
String of comma separated selected item IDs from the list. This is used by GUI to remember, which IDs were selected so if the reloaded list contains the same IDs it can select them again


m_strMarkedItemIDs

protected java.lang.String m_strMarkedItemIDs
String of comma separated marked item IDs from the list. This is used by GUI to remember, which IDs were highlighted or otherwise flagged so if the reloaded list contains the same IDs it can select them again.


m_iFirstVisibleItem

protected int m_iFirstVisibleItem
Identification of first visible item on the GUI. This can be anything, pixels to scroll, index of the first element, it depends on how the GUI is constructed.


m_iClientOrderCode

protected int m_iClientOrderCode
Code of the client column to order the list by on the client. This provides the ability to sort the entire list on the server using some column and then on the client sort the page using different column


m_strClientOrderDirection

protected java.lang.String m_strClientOrderDirection
Type of the client ordering ASC/DESC. See ORDER_XXX constants in ListDefinition.


m_definition

protected ListDefinition m_definition
Basic definition used for this list. All other attributes may override data in this definition.


m_arrShowColumnCodes

protected int[] m_arrShowColumnCodes
List of columns codes representing data object attributes, which are shown in the list in GUI. This is not necessary the list of fields which will be retrieved from the database since some fields such as IDs of the objects are never shown on the GUI but they are still needed to construct the page.


m_arrRetrieveColumnCodes

protected int[] m_arrRetrieveColumnCodes
List of columns codes representing data object attributes, which are retrieved from the database. It is a superset of m_arrShowColumnCodes;


m_arrSortableColumnCodes

protected int[] m_arrSortableColumnCodes
List of columns codes which could be used to sort data by the persistance store. This is needed due to the fact that some databases (e.g. SAPDB) doesn't allow columns of certain data types (long VARCHAR) to be used in ORDER BY clause. This is variable is set by the persistance layer layer when the data structure is passed to it during data retrieval. If the data structure is not passed through database layer that it is not known which columns can be used for sorting or not and this value will be null. At then it is up to the caller to decide how does it wants to deal with this situation (if to assume that all columns are sortable or be conservative and assume none are).


m_arrFilterableColumnCodes

protected int[] m_arrFilterableColumnCodes
List of columns codes which could be used to filter data by the persistance store. This is variable is set by the persistance layer layer when the data structure is passed to it during data retrieval. If the data structure is not passed through database layer that it is not known which columns can be used for filtering or not and this value will be null. At then it is up to the caller to decide how does it wants to deal with this situation (if to assume that all columns are filterable or be conservative and assume none are).


m_iParentDataType

protected int m_iParentDataType
Data type of parent object of the list of data. This can be used for example when all data objects displayed in the list should belong to the same parent.


m_iParentId

protected int m_iParentId
ID of parent object of the list of data. This can be used for example when all data objects displayed in the list should belong to the same parent.


m_strIgnoredItemIDs

protected java.lang.String m_strIgnoredItemIDs
Comma separated list of IDs of items which should not be loaded even though they satisfy filter, extra and security conditions.


m_securityFilter

protected SimpleRule m_securityFilter
Filter defining what data has user rights to access. This prevents us from loading data, which user cannot see.


m_extraFilter

protected SimpleRule m_extraFilter
Filter specifying extra conditions which data has to satisfy. It is combined with the data conditions specified by list definition and with security filter.


m_iExtraLogicalOperation

protected int m_iExtraLogicalOperation
Logical operation used to merge extra filter with the ones from list definition. The security is alwasy merged in such a way that it has to be satisfied. This can be one of SimpleRule..LOGICAL_XXX constants.


m_bDistinct

protected boolean m_bDistinct
Load only distinct items. Use (true) this very carefully since it will cause sorting and it will slow down the query.


m_bKeepSelected

protected boolean m_bKeepSelected
Load also previously selected items even if they are not in the current range of items to load. Depends on 'Keep selected' checkbox in the scrollable table footer.


m_iDomainId

protected int m_iDomainId
Domain ID that will be used for constructing query for getting object list. This gives us possibility to retrieve list of objects not only from current domain but also from other domain (e.g. for administering another domains).

Constructor Detail

ListOptions

public ListOptions(java.lang.Class listFactoryClass)
Empty list options initialized to default parameters

Parameters:
listFactoryClass - - class representing data factory that implements list factory interface to use to retrieve data for list of data objects

ListOptions

public ListOptions(java.lang.Class listFactoryClass,
                   java.lang.String strDefinitionId,
                   int iPageSize,
                   int iActualListSize,
                   int[] arrOrderColumnCodes,
                   java.lang.String[] arrOrderDirections,
                   int iClientOrderCode,
                   java.lang.String strClientOrderDirection,
                   int iBeginPosition,
                   int iEndPosition,
                   int iActualPage,
                   int iFirstVisibleItem,
                   int iParentDataType,
                   int iParentId,
                   java.lang.String strSelectedItemIds,
                   java.lang.String strMarkedItemIds,
                   int[] arrShowColumnCodes,
                   java.lang.String strIgnoredItemIds,
                   boolean bDistinct,
                   boolean bKeepSelected,
                   int iDomainId)
Parameters:
listFactoryClass - - class representing data factory that implements list factory interface to use to retrieve data for list of data objects
strDefinitionId - - string id of definition used as a basis for this list This ID can be pure numeric value (id) or there can be stored whole Filter object values that have to be parsed. These filter values are used when Filter GUI values have to be applied.
iPageSize - - page size
iActualListSize - - number of all items in list
arrOrderColumnCodes - - codes for columns to order by, pass null if none
arrOrderDirections - - order directions (ASC/DESC), see constants in ListDefinition
iClientOrderCode - - client order column code
strClientOrderDirection - - client order type (ASC/DESC), see constants in ListDefinition
iBeginPosition - - relative begin position
iEndPosition - - relative end position
iActualPage - - actual page number
iFirstVisibleItem - - first visible
iParentDataType - - parent data type
iParentId - - parent ID
strSelectedItemIds - - String of selected items IDs divided by comma
strMarkedItemIds - - String of marked items IDs divided by comma
arrShowColumnCodes - - array of showed columns codes (ordered)
strIgnoredItemIds - - String of ignored items IDs divided by comma
bDistinct - - if true only distinct items will be listed. Use (true) this very carefully since it will cause sorting and it will slow down the query.
bKeepSelected - - true = if will be loaded also previously selected items
iDomainId - - domain ID
Method Detail

getListFactoryClass

public java.lang.Class getListFactoryClass()
Returns:
Class - class representing data factory that implements list factory interface to use to retrieve data for list of data objects

getSelectedItemIDs

public java.lang.String getSelectedItemIDs()
Returns:
String

getMarkedItemIDs

public java.lang.String getMarkedItemIDs()
Returns:
String

getIgnoredItemIDs

public java.lang.String getIgnoredItemIDs()
Returns:
String

getActualPage

public int getActualPage()
Returns:
int

getBeginPosition

public int getBeginPosition()
Returns:
int

getClientOrderCode

public int getClientOrderCode()
Returns:
int

getEndPosition

public int getEndPosition()
Returns:
int

getDefinitionId

public java.lang.String getDefinitionId()
Returns:
String

getFirstVisibleItem

public int getFirstVisibleItem()
Returns:
int

getOrderColumnCodes

public int[] getOrderColumnCodes()
Returns:
int[]

getPageSize

public int getPageSize()
Returns:
int

setSelectedItemIDs

public void setSelectedItemIDs(java.lang.String strSelectedItems)
Set IDs of the items, which are or should be selected on the GUI.

Parameters:
strSelectedItems - - array of selected item IDs

setMarkedItemIDs

public void setMarkedItemIDs(java.lang.String strMarkedItemIDs)
Set IDs of the items, which are or should be highlighted or otherwise marked on the GUI.

Parameters:
strMarkedItemIDs - - marked item IDs

setIgnoredItemIDs

public void setIgnoredItemIDs(java.lang.String strIgnoredItems)
Select IDs of tiems which shouldn't be loaded even through they satisfy other conditions.

Parameters:
strIgnoredItems - - string of ignored item IDs (separated by ',')

setActualPage

public void setActualPage(int iActualPage)
Set the page which should be the actual page shown.

Parameters:
iActualPage - - actual page number

setBeginPosition

public void setBeginPosition(int iBeginPosition)
Set the begin position which is the position of the first element in the full list of elements.

Parameters:
iBeginPosition - - relative begin position

setClientOrderCode

public void setClientOrderCode(int iClientOrderCode)
Parameters:
iClientOrderCode - - client order column code

setEndPosition

public void setEndPosition(int iEndPosition)
Set the end position which is the position of the first element in the full list of elements.

Parameters:
iEndPosition - - relative end position

setDefinitionId

public void setDefinitionId(java.lang.String strDefinitionId)
Parameters:
strDefinitionId - - list definition id

setFirstVisibleItem

public void setFirstVisibleItem(int iFirstVisibleItem)
Parameters:
iFirstVisibleItem - - first visible item relative position

setOrdering

public void setOrdering(int[] arrOrderColumnCodes,
                        java.lang.String[] arrOrderDirections)
Parameters:
arrOrderColumnCodes - - codes for columns to order by, pass null if none
arrOrderDirections - - direction of ordering for each column

setPageSize

public void setPageSize(int iPageSize)
Parameters:
iPageSize - - page size

getActualListSize

public int getActualListSize()
Returns:
int

setActualListSize

public void setActualListSize(int iActualListSize)
Parameters:
iActualListSize - - complete list size

getDefinition

public ListDefinition getDefinition()
Returns:
ListDefinition

setDefinition

public void setDefinition(ListDefinition definition)
Parameters:
definition - - list definition

getShowColumnCodes

public int[] getShowColumnCodes()
Returns:
int[]

setShowColumnCodes

public void setShowColumnCodes(int[] arrShowColumnCodes)
Parameters:
arrShowColumnCodes - - array of column codes

getClientOrderDirection

public java.lang.String getClientOrderDirection()
Returns:
String - one of the ListDefinition.ORDER_XXX constants

getOrderDirections

public java.lang.String[] getOrderDirections()
Returns:
String[]

setClientOrderDirection

public void setClientOrderDirection(java.lang.String strClientOrderDirection)
Parameters:
strClientOrderDirection - - client type for ordering, one of the ListDefinition.ORDER_XXX constants

getSecurityFilter

public SimpleRule getSecurityFilter()
Returns:
SimpleRule

setSecurityFilter

public void setSecurityFilter(SimpleRule securityRule)
Parameters:
securityRule - - list security data

getIsFirstPage

public boolean getIsFirstPage()
Check if the list is on the first page Used by JSP

Returns:
boolean - if it is first page

getIsLastPage

public boolean getIsLastPage()
Check if the list is on the last page Used by JSP

Returns:
boolean - if it is last page

getGoToPages

public java.util.List getGoToPages()
Generate list of pages to which user can jump directly. Make sure the list is not too long. Used by JSP

Returns:
List - list of strings with page numbers

getAbsolutePageCount

public int getAbsolutePageCount()
Absolute page count is total amount of pages of data independent from the current position in the list.

Returns:
int

getRelativePageCount

public int getRelativePageCount()
Relative page count is total amount of pages of data relative to the current position in the list since beucase our current position doesn't have to be alligned with page boundaries there might be 1 more page before or after the current position which wouldn't be there otherwise.

Returns:
int

getRetrieveColumnCodes

public int[] getRetrieveColumnCodes()
Get list of columns codes which were/should be retrieved from the database. This is different that the columns which will be shown to the user since some column on UI may be a combination of multiple columns from the persistance store and vice versa. This is set by the persistance layer once the ListOptions instance passes through it.

Returns:
int[] - list of columns codes which were/should be retrieved from the database.

setRetrieveColumnCodes

public void setRetrieveColumnCodes(int[] arrRetrieveColumnCodes)
Set list of columns codes which were/should be retrieved from the persistance store. This is different that the columns which will be shown to the user since some column on UI may be a combination of multiple columns from the persistance store and vice versa. This is set by the persistance layer once the ListOptions instance passes through it.

Parameters:
arrRetrieveColumnCodes - - list of columns codes which were/should be retrieved from the database.

getSortableColumnCodes

public int[] getSortableColumnCodes()
Get list of columns codes which could be used to sort data by the persistance store. This is needed due to the fact that some databases (e.g. SAPDB) doesn't allow columns of certain data types (long VARCHAR) to be used in ORDER BY clause. This is variable is set by the persistance layer layer when the data structure is passed to it during data retrieval. If the data structure is not passed through database layer that it is not known which columns can be used for sorting or not and this value will be null. At then it is up to the caller to decide how does it wants to deal with this situation (if to assume that all columns are sortable or be conservative and assume none are).

Returns:
int[] - list of columns codes which could be used to sort data by the database. If null then we do not know what data can be used.

setSortableColumnCodes

public void setSortableColumnCodes(int[] arrSortableColumnCodes)
Set list of columns codes which could be used to sort data by the persistance store. This is needed due to the fact that some databases (e.g. SAPDB) doesn't allow columns of certain data types (long VARCHAR) to be used in ORDER BY clause. This is variable is set by the persistance layer layer when the data structure is passed to it during data retrieval. If the data structure is not passed through database layer that it is not known which columns can be used for sorting or not and this value will be null. At then it is up to the caller to decide how does it wants to deal with this situation (if to assume that all columns are sortable or be conservative and assume none are).

Parameters:
arrSortableColumnCodes - - list of columns codes which could be used to sort data by the database.

getFilterableColumnCodes

public int[] getFilterableColumnCodes()
Get list of columns codes which could be used to filter data by the persistance store. This is variable is set by the persistance layer layer when the data structure is passed to it during data retrieval. If the data structure is not passed through database layer that it is not known which columns can be used for filtering or not and this value will be null. At then it is up to the caller to decide how does it wants to deal with this situation (if to assume that all columns are filterable or be conservative and assume none are).

Returns:
int[] - list of columns codes which could be used to filter data by the database. If null then we do not know what data can be used.

setFilterableColumnCodes

public void setFilterableColumnCodes(int[] arrFilterableColumnCodes)
Set llist of columns codes which could be used to filter data by the persistance store. This is variable is set by the persistance layer layer when the data structure is passed to it during data retrieval. If the data structure is not passed through database layer that it is not known which columns can be used for filtering or not and this value will be null. At then it is up to the caller to decide how does it wants to deal with this situation (if to assume that all columns are filterable or be conservative and assume none are).

Parameters:
arrFilterableColumnCodes - - list of columns codes which could be used to filter data by the database. If null then we do not know what data can be used.

getParentDataType

public int getParentDataType()
Returns:
int - list parent data type

getParentId

public int getParentId()
Returns:
int - list parent ID

setParentDataType

public void setParentDataType(int iParentDataType)
Parameters:
iParentDataType - - list parent data type

setParentId

public void setParentId(int iParentId)
Parameters:
iParentId - - list parent ID

getDomainId

public int getDomainId()
Returns:
int - list domain ID

setDomainId

public void setDomainId(int iDomainId)
Parameters:
iDomainId - - list domain ID

getExtraFilter

public SimpleRule getExtraFilter()
Returns:
SimpleRule - if not null then these are extra conditions which should be applied together with the default definition filter

getIsKeepSelectedChecked

public boolean getIsKeepSelectedChecked()
Returns:
boolean - if Keep selected checkbox is checked

getKeepSelected

public int getKeepSelected()
Returns:
int - if Keep selected checkbox is checked

setKeepSelected

public void setKeepSelected(boolean bKeepSelected)
Parameters:
bKeepSelected - - if Keep selected checkbox is checked

setExtraFilter

public void setExtraFilter(SimpleRule extraFilter,
                           int iExtraLogicalOperation)
Parameters:
extraFilter - - if not null then these are extra conditions which should be applied together with filter.
iExtraLogicalOperation - - can be one of the SimpleRule.LOGICAL_XXX constants

getExtraLogicalOperation

public int getExtraLogicalOperation()
Returns:
int - can be one of the SimpleRule.LOGICAL_XXX constants

isDistinct

public boolean isDistinct()
Returns:
boolean - if true only distinct items should be loaded

setDistinct

public void setDistinct(boolean bDistinct)
Parameters:
bDistinct - - if true only distinct items will be listed. Use (true) this very carefully since it will cause sorting and it will slow down the query.

getExtraConditionAttribute

public int getExtraConditionAttribute()
Get attribute of the single extra condition that is part of the extra filter. If the extra filter contains none or more than one condition, this method will return NO_ATTRIBUTE constant. This method is here to simlify coding of the web user interface pages which often needs to access this particular attribute.

Returns:
String - attribute of the single extra condition that is part of the extra filter. If the extra filter contains none or more than one condition, this method will return NO_ATTRIBUTE constant.

getExtraConditionValue

public java.lang.String getExtraConditionValue()
Get value of the single extra condition that is part of the extra filter. If the extra filter contains none or more than one condition, this method will return empty string. This method is here to simlify coding of the web user interface pages which often needs to access this particular attribute.

Returns:
String - value of the single extra condition that is part of the extra filter. If the extra filter contains none or more than one condition, this method will return empty string.


Copyright © 2003 - 2006 OpenSubsystems s.r.o.