Package org.openbravo.service.datasource

Class DataSource

java.lang.Object

org.openbravo.base.structure.BaseOBObject

org.openbravo.service.datasource.DataSource

All Implemented Interfaces:

Serializable, BaseOBObjectDef, OBNotSingleton, OBProvidable, ActiveEnabled, ClientEnabled, DynamicEnabled, Identifiable, OrganizationEnabled, Traceable

public class DataSource
extends BaseOBObject
implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled

Entity class for entity OBSERDS_Datasource (stored in table OBSERDS_Datasource).
Help: A datasource is used to provide data to user interface components running on the client. The data can be read from the database or can be computed at runtime in memory. Data consists mostly of records with fields which are displayed on the client in forms and grids.
NOTE: This class should not be instantiated directly. To instantiate this class the OBProvider should be used.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENTITY_NAME
static String	PROPERTY_ACTIVE	Property active stored in column Isactive in table OBSERDS_Datasource
static String	PROPERTY_ADTABLETREELIST	Property aDTableTreeList stored in table OBSERDS_Datasource
static String	PROPERTY_CLIENT	Property client stored in column AD_Client_ID in table OBSERDS_Datasource
static String	PROPERTY_CREATEDBY	Property createdBy stored in column Createdby in table OBSERDS_Datasource
static String	PROPERTY_CREATIONDATE	Property creationDate stored in column Created in table OBSERDS_Datasource
static String	PROPERTY_DESCRIPTION	Property description stored in column Description in table OBSERDS_Datasource Help: A description is limited to 255 characters.
static String	PROPERTY_HQLWHERECLAUSE	Property hQLWhereClause stored in column Whereclause in table OBSERDS_Datasource Help: The HQL where clause is added to the query to retrieve the data which is returned by the datasource.
static String	PROPERTY_ID	Property id stored in column Obserds_Datasource_ID in table OBSERDS_Datasource Help: The datasource provides data from the database or from in-memory data.
static String	PROPERTY_JAVACLASSNAME	Property javaClassName stored in column Classname in table OBSERDS_Datasource Help: Class implementing the functionality in java
static String	PROPERTY_MODULE	Property module stored in column AD_Module_ID in table OBSERDS_Datasource Help: Indicates the module the element forms part of.
static String	PROPERTY_NAME	Property name stored in column Name in table OBSERDS_Datasource
static String	PROPERTY_OBSERDSDATASOURCEFIELDLIST	Property oBSERDSDatasourceFieldList stored in table OBSERDS_Datasource
static String	PROPERTY_ORGANIZATION	Property organization stored in column AD_Org_ID in table OBSERDS_Datasource
static String	PROPERTY_SUPPORTIDFKFILTERING	Property supportIdFkFiltering stored in column Idfkfiltering in table OBSERDS_Datasource Help: If this flag is checked, when a foreign key is filtered by selecting a value from the filter drop down, the foreign key will be filtered using its id. If this flag is not checked, the foreign key will be filtered using its identifier.
static String	PROPERTY_TABLE	Property table stored in column AD_Table_ID in table OBSERDS_Datasource Help: The Table indicates the table in which a field or fields reside.
static String	PROPERTY_TEMPLATE	Property template stored in column Obclker_template_ID in table OBSERDS_Datasource Help: The template used to generate the client-side representation (in the browser) of the datasource.
static String	PROPERTY_UPDATED	Property updated stored in column Updated in table OBSERDS_Datasource
static String	PROPERTY_UPDATEDBY	Property updatedBy stored in column Updatedby in table OBSERDS_Datasource
static String	PROPERTY_USEASTABLEDATAORIGIN	Property useAsTableDataOrigin stored in column Useastabledataorigin in table OBSERDS_Datasource Help: A flag indicating whether this datasource is used as a data origin in the Table window. In that case, the Table and Column subtabs of the Datasource window are hidden, because the columns of the datasource must be defined in the Columns tab of the Tables and Columns window.
static String	TABLE_NAME

Fields inherited from class org.openbravo.base.structure.BaseOBObject

ID

Constructor Summary

Constructors

Constructor	Description
DataSource()

Method Summary

Modifier and Type	Method	Description
List<TableTree>	getADTableTreeList()
Client	getClient()	Client field
User	getCreatedBy()	Created by audit user
Date	getCreationDate()	Creation date of audit
String	getDescription()
String	getEntityName()
String	getHQLWhereClause()
String	getId()
String	getJavaClassName()
Module	getModule()
String	getName()
List<DatasourceField>	getOBSERDSDatasourceFieldList()	Help: A data source returns records which have field. The fields, their name and type, are defined in the data source field.
Organization	getOrganization()	Gets organization field
Table	getTable()
Template	getTemplate()
Date	getUpdated()	Update date of audit
User	getUpdatedBy()	Update by audit user
Boolean	isActive()	Gets active field
Boolean	isSupportIdFkFiltering()
Boolean	isUseAsTableDataOrigin()
void	setActive(Boolean active)	Sets active field
void	setADTableTreeList(List<TableTree> aDTableTreeList)
void	setClient(Client client)	Client field
void	setCreatedBy(User createdBy)	Created by audit user
void	setCreationDate(Date creationDate)	Creation date of audit
void	setDescription(String description)
void	setHQLWhereClause(String hQLWhereClause)
void	setId(String id)
void	setJavaClassName(String javaClassName)
void	setModule(Module module)
void	setName(String name)
void	setOBSERDSDatasourceFieldList(List<DatasourceField> oBSERDSDatasourceFieldList)	Help: A data source returns records which have field. The fields, their name and type, are defined in the data source field.
void	setOrganization(Organization organization)	Sets organization field
void	setSupportIdFkFiltering(Boolean supportIdFkFiltering)
void	setTable(Table table)
void	setTemplate(Template template)
void	setUpdated(Date updated)	Update date of audit
void	setUpdatedBy(User updatedBy)	Update by audit user
void	setUseAsTableDataOrigin(Boolean useAsTableDataOrigin)

Methods inherited from class org.openbravo.base.structure.BaseOBObject

checkDerivedReadable, get, get, get, getEntity, getIdentifier, getValue, isAllowRead, isNewOBObject, isOrgClientAccessCheckEnabled, isWriteAccessCheckEnabled, set, setAccessChecks, setAllowRead, setDefaultValue, setId, setNewOBObject, setValue, toString, validate

Methods inherited from class java.lang.Object

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

Field Detail

TABLE_NAME

public static final String TABLE_NAME

See Also:

Constant Field Values

ENTITY_NAME

public static final String ENTITY_NAME

See Also:

Constant Field Values

PROPERTY_ID

public static final String PROPERTY_ID

Property id stored in column Obserds_Datasource_ID in table OBSERDS_Datasource
Help: The datasource provides data from the database or from in-memory data.

See Also:

Constant Field Values

PROPERTY_CLIENT

public static final String PROPERTY_CLIENT

Property client stored in column AD_Client_ID in table OBSERDS_Datasource

See Also:

ClientEnabled, Constant Field Values

PROPERTY_ORGANIZATION

public static final String PROPERTY_ORGANIZATION

Property organization stored in column AD_Org_ID in table OBSERDS_Datasource

See Also:

OrganizationEnabled, Constant Field Values

PROPERTY_MODULE

public static final String PROPERTY_MODULE

Property module stored in column AD_Module_ID in table OBSERDS_Datasource
Help: Indicates the module the element forms part of.

See Also:

Constant Field Values

PROPERTY_NAME

public static final String PROPERTY_NAME

Property name stored in column Name in table OBSERDS_Datasource

See Also:

Constant Field Values

PROPERTY_DESCRIPTION

public static final String PROPERTY_DESCRIPTION

Property description stored in column Description in table OBSERDS_Datasource
Help: A description is limited to 255 characters.

See Also:

Constant Field Values

PROPERTY_TABLE

public static final String PROPERTY_TABLE

Property table stored in column AD_Table_ID in table OBSERDS_Datasource
Help: The Table indicates the table in which a field or fields reside.

See Also:

Constant Field Values

PROPERTY_HQLWHERECLAUSE

public static final String PROPERTY_HQLWHERECLAUSE

Property hQLWhereClause stored in column Whereclause in table OBSERDS_Datasource
Help: The HQL where clause is added to the query to retrieve the data which is returned by the datasource.

See Also:

Constant Field Values

PROPERTY_JAVACLASSNAME

public static final String PROPERTY_JAVACLASSNAME

Property javaClassName stored in column Classname in table OBSERDS_Datasource
Help: Class implementing the functionality in java

See Also:

Constant Field Values

PROPERTY_TEMPLATE

public static final String PROPERTY_TEMPLATE

Property template stored in column Obclker_template_ID in table OBSERDS_Datasource
Help: The template used to generate the client-side representation (in the browser) of the datasource.

See Also:

Constant Field Values

PROPERTY_ACTIVE

public static final String PROPERTY_ACTIVE

Property active stored in column Isactive in table OBSERDS_Datasource

See Also:

ActiveEnabled, Constant Field Values

PROPERTY_CREATIONDATE

public static final String PROPERTY_CREATIONDATE

Property creationDate stored in column Created in table OBSERDS_Datasource

See Also:

Traceable, Constant Field Values

PROPERTY_CREATEDBY

public static final String PROPERTY_CREATEDBY

Property createdBy stored in column Createdby in table OBSERDS_Datasource

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATED

public static final String PROPERTY_UPDATED

Property updated stored in column Updated in table OBSERDS_Datasource

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATEDBY

public static final String PROPERTY_UPDATEDBY

Property updatedBy stored in column Updatedby in table OBSERDS_Datasource

See Also:

Traceable, Constant Field Values

PROPERTY_USEASTABLEDATAORIGIN

public static final String PROPERTY_USEASTABLEDATAORIGIN

Property useAsTableDataOrigin stored in column Useastabledataorigin in table OBSERDS_Datasource
Help: A flag indicating whether this datasource is used as a data origin in the Table window. In that case, the Table and Column subtabs of the Datasource window are hidden, because the columns of the datasource must be defined in the Columns tab of the Tables and Columns window.

See Also:

Constant Field Values

PROPERTY_SUPPORTIDFKFILTERING

public static final String PROPERTY_SUPPORTIDFKFILTERING

Property supportIdFkFiltering stored in column Idfkfiltering in table OBSERDS_Datasource
Help: If this flag is checked, when a foreign key is filtered by selecting a value from the filter drop down, the foreign key will be filtered using its id. If this flag is not checked, the foreign key will be filtered using its identifier.

See Also:

Constant Field Values

PROPERTY_ADTABLETREELIST

public static final String PROPERTY_ADTABLETREELIST

Property aDTableTreeList stored in table OBSERDS_Datasource

See Also:

Constant Field Values

PROPERTY_OBSERDSDATASOURCEFIELDLIST

public static final String PROPERTY_OBSERDSDATASOURCEFIELDLIST

Property oBSERDSDatasourceFieldList stored in table OBSERDS_Datasource

See Also:

Constant Field Values

Constructor Detail

DataSource

public DataSource()

Method Detail

getEntityName

public String getEntityName()

Specified by:

getEntityName in interface Identifiable

Specified by:

getEntityName in class BaseOBObject

getId

public String getId()

Specified by:

getId in interface BaseOBObjectDef

Specified by:

getId in interface Identifiable

Overrides:

getId in class BaseOBObject

See Also:

PROPERTY_ID

setId

public void setId(String id)

See Also:

PROPERTY_ID

getClient

public Client getClient()

Description copied from interface: ClientEnabled

Client field

Specified by:

getClient in interface ClientEnabled

Returns:

client

See Also:

PROPERTY_CLIENT

setClient

public void setClient(Client client)

Description copied from interface: ClientEnabled

Client field

Specified by:

setClient in interface ClientEnabled

See Also:

PROPERTY_CLIENT

getOrganization

public Organization getOrganization()

Description copied from interface: OrganizationEnabled

Gets organization field

Specified by:

getOrganization in interface OrganizationEnabled

Returns:

organization

See Also:

PROPERTY_ORGANIZATION

setOrganization

public void setOrganization(Organization organization)

Description copied from interface: OrganizationEnabled

Sets organization field

Specified by:

setOrganization in interface OrganizationEnabled

See Also:

PROPERTY_ORGANIZATION

getModule

public Module getModule()

See Also:

PROPERTY_MODULE

setModule

public void setModule(Module module)

See Also:

PROPERTY_MODULE

getName

public String getName()

See Also:

PROPERTY_NAME

setName

public void setName(String name)

See Also:

PROPERTY_NAME

getDescription

public String getDescription()

See Also:

PROPERTY_DESCRIPTION

setDescription

public void setDescription(String description)

See Also:

PROPERTY_DESCRIPTION

getTable

public Table getTable()

See Also:

PROPERTY_TABLE

setTable

public void setTable(Table table)

See Also:

PROPERTY_TABLE

getHQLWhereClause

public String getHQLWhereClause()

See Also:

PROPERTY_HQLWHERECLAUSE

setHQLWhereClause

public void setHQLWhereClause(String hQLWhereClause)

See Also:

PROPERTY_HQLWHERECLAUSE

getJavaClassName

public String getJavaClassName()

See Also:

PROPERTY_JAVACLASSNAME

setJavaClassName

public void setJavaClassName(String javaClassName)

See Also:

PROPERTY_JAVACLASSNAME

getTemplate

public Template getTemplate()

See Also:

PROPERTY_TEMPLATE

setTemplate

public void setTemplate(Template template)

See Also:

PROPERTY_TEMPLATE

isActive

public Boolean isActive()

Description copied from interface: ActiveEnabled

Gets active field

Specified by:

isActive in interface ActiveEnabled

Returns:

active

See Also:

PROPERTY_ACTIVE

setActive

public void setActive(Boolean active)

Description copied from interface: ActiveEnabled

Sets active field

Specified by:

setActive in interface ActiveEnabled

See Also:

PROPERTY_ACTIVE

getCreationDate

public Date getCreationDate()

Description copied from interface: Traceable

Creation date of audit

Specified by:

getCreationDate in interface Traceable

Returns:

Date of creation

See Also:

PROPERTY_CREATIONDATE

setCreationDate

public void setCreationDate(Date creationDate)

Description copied from interface: Traceable

Creation date of audit

Specified by:

setCreationDate in interface Traceable

See Also:

PROPERTY_CREATIONDATE

getCreatedBy

public User getCreatedBy()

Description copied from interface: Traceable

Created by audit user

Specified by:

getCreatedBy in interface Traceable

Returns:

User

See Also:

PROPERTY_CREATEDBY

setCreatedBy

public void setCreatedBy(User createdBy)

Description copied from interface: Traceable

Created by audit user

Specified by:

setCreatedBy in interface Traceable

See Also:

PROPERTY_CREATEDBY

getUpdated

public Date getUpdated()

Description copied from interface: Traceable

Update date of audit

Specified by:

getUpdated in interface Traceable

Returns:

Date of update

See Also:

PROPERTY_UPDATED

setUpdated

public void setUpdated(Date updated)

Description copied from interface: Traceable

Update date of audit

Specified by:

setUpdated in interface Traceable

See Also:

PROPERTY_UPDATED

getUpdatedBy

public User getUpdatedBy()

Description copied from interface: Traceable

Update by audit user

Specified by:

getUpdatedBy in interface Traceable

Returns:

User who updated

See Also:

PROPERTY_UPDATEDBY

setUpdatedBy

public void setUpdatedBy(User updatedBy)

Description copied from interface: Traceable

Update by audit user

Specified by:

setUpdatedBy in interface Traceable

See Also:

PROPERTY_UPDATEDBY

isUseAsTableDataOrigin

public Boolean isUseAsTableDataOrigin()

See Also:

PROPERTY_USEASTABLEDATAORIGIN

setUseAsTableDataOrigin

public void setUseAsTableDataOrigin(Boolean useAsTableDataOrigin)

See Also:

PROPERTY_USEASTABLEDATAORIGIN

isSupportIdFkFiltering

public Boolean isSupportIdFkFiltering()

See Also:

PROPERTY_SUPPORTIDFKFILTERING

setSupportIdFkFiltering

public void setSupportIdFkFiltering(Boolean supportIdFkFiltering)

See Also:

PROPERTY_SUPPORTIDFKFILTERING

getADTableTreeList

public List<TableTree> getADTableTreeList()

See Also:

TableTree

setADTableTreeList

public void setADTableTreeList(List<TableTree> aDTableTreeList)

See Also:

TableTree

getOBSERDSDatasourceFieldList

public List<DatasourceField> getOBSERDSDatasourceFieldList()

Help: A data source returns records which have field. The fields, their name and type, are defined in the data source field.

See Also:

DatasourceField

setOBSERDSDatasourceFieldList

public void setOBSERDSDatasourceFieldList(List<DatasourceField> oBSERDSDatasourceFieldList)

Help: A data source returns records which have field. The fields, their name and type, are defined in the data source field.

See Also:

DatasourceField