Package org.openbravo.client.querylist

Class QueryListDataSource

java.lang.Object

org.openbravo.service.datasource.BaseDataSourceService

org.openbravo.service.datasource.DefaultDataSourceService

org.openbravo.service.datasource.ReadOnlyDataSourceService

org.openbravo.client.querylist.QueryListDataSource

All Implemented Interfaces:

PortalAccessible, DataSourceService

public class QueryListDataSource
extends ReadOnlyDataSourceService
implements PortalAccessible

Reads the tabs which the user is allowed to see.

Author:

gorkaion

Constructor Summary

Constructors

Constructor	Description
QueryListDataSource()

Method Summary

Modifier and Type	Method	Description
void	checkFetchDatasourceAccess(Map<String,String> parameters)	This method allows to implement a security access to a DataSource when it is used fetch() method.
protected int	getCount(Map<String,String> parameters)	Returns the count of objects based on the passed parameters.
protected List<Map<String,Object>>	getData(Map<String,String> parameters, int startRow, int endRow)	Read/create the set of data as a list of Maps with key-value pairs.
List<DataSourceProperty>	getDataSourceProperties(Map<String,Object> parameters)	Create the properties used in the template.
protected void	sort(String sortBy, List<Map<String,Object>> data)	Sorts the data list by the value of the passed in sortBy key

Methods inherited from class org.openbravo.service.datasource.ReadOnlyDataSourceService

add, fetch, fetch, remove, update

Methods inherited from class org.openbravo.service.datasource.DefaultDataSourceService

add, addFetchParameters, fetch, getInitialProperties, remove

Methods inherited from class org.openbravo.service.datasource.BaseDataSourceService

checkEditDatasourceAccess, getDataSource, getDataUrl, getEntity, getName, getTemplate, getWhereAndFilterClause, getWhereClause, handleExceptionUnsecuredDSAccess, setDataSource, setDataUrl, setEntity, setName, setWhereClause

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryListDataSource

public QueryListDataSource()

Method Detail

checkFetchDatasourceAccess

public void checkFetchDatasourceAccess(Map<String,String> parameters)

Description copied from interface: DataSourceService

This method allows to implement a security access to a DataSource when it is used fetch() method. It can be overridden in specific DataSources to apply a particular security mechanism.

Specified by:

checkFetchDatasourceAccess in interface DataSourceService

Overrides:

checkFetchDatasourceAccess in class BaseDataSourceService

getCount

protected int getCount(Map<String,String> parameters)

Returns the count of objects based on the passed parameters.

Specified by:

getCount in class ReadOnlyDataSourceService

Parameters:

parameters - the parameters passed in from the request

Returns:

the total number of objects

getData

protected List<Map<String,Object>> getData(Map<String,String> parameters,
                                                 int startRow,
                                                 int endRow)

Description copied from class: ReadOnlyDataSourceService

Read/create the set of data as a list of Maps with key-value pairs.

Specified by:

getData in class ReadOnlyDataSourceService

Parameters:

parameters - the parameters passed in from the request

startRow - the first row to read (maybe -1 to indicate no startrow)

endRow - the last row to read (maybe -1 to indicate no endrow

Returns:

the number of objects read, note that this maybe more than endRow - startRow + 1. The startRow parameter should be strictly followed though.

getDataSourceProperties

public List<DataSourceProperty> getDataSourceProperties(Map<String,Object> parameters)

Description copied from interface: DataSourceService

Create the properties used in the template.

Specified by:

getDataSourceProperties in interface DataSourceService

Overrides:

getDataSourceProperties in class DefaultDataSourceService

Parameters:

parameters - parameters used for this request

Returns:

the list of DataSourceProperty instances to use in the template

sort

protected void sort(String sortBy,
                    List<Map<String,Object>> data)

Description copied from class: ReadOnlyDataSourceService

Sorts the data list by the value of the passed in sortBy key

Overrides:

sort in class ReadOnlyDataSourceService

Parameters:

sortBy - the