Package org.openbravo.client.querylist

Class OBCQL_QueryColumn

java.lang.Object

org.openbravo.base.structure.BaseOBObject

org.openbravo.client.querylist.OBCQL_QueryColumn

All Implemented Interfaces:

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

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

Entity class for entity OBCQL_QueryColumn (stored in table OBCQL_Query_Column).
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 OBCQL_Query_Column
static String	PROPERTY_CANBEFILTERED	Property canBeFiltered stored in column Can_Be_Filtered in table OBCQL_Query_Column Help: This flag sets whether it is possible to filter the grid by this column or not on maximized view.
static String	PROPERTY_CLIENT	Property client stored in column AD_Client_ID in table OBCQL_Query_Column
static String	PROPERTY_CLIENTCLASS	Property clientClass stored in column Clientclass in table OBCQL_Query_Column
static String	PROPERTY_CREATEDBY	Property createdBy stored in column Createdby in table OBCQL_Query_Column
static String	PROPERTY_CREATIONDATE	Property creationDate stored in column Created in table OBCQL_Query_Column
static String	PROPERTY_DISPLAYEXPRESSION	Property displayExpression stored in column Display_Expression in table OBCQL_Query_Column Help: Alias of HQL query column to be shown
static String	PROPERTY_HASLINK	Property hasLink stored in column Has_Link in table OBCQL_Query_Column Help: Flag to set that the field of the grid will have a link
static String	PROPERTY_ID	Property id stored in column OBCQL_Query_Column_ID in table OBCQL_Query_Column Help: Column of the defined query that it is desired to be shown or exported
static String	PROPERTY_INCLUDEIN	Property includeIn stored in column Include_In in table OBCQL_Query_Column Help: Sets the visibility of the column: - Widget view, column is shown on all cases. - Maximized view, column is shown only in maximized view and included in the exported file. - Exported file, column is only included in the exported file.
static String	PROPERTY_LINKEXPRESSION	Property linkExpression stored in column Link_Expression in table OBCQL_Query_Column Help: Alias of the HQL Query column with the id required to built the link
static String	PROPERTY_NAME	Property name stored in column Name in table OBCQL_Query_Column
static String	PROPERTY_OBCQLQUERYCOLUMNTRLLIST	Property oBCQLQueryColumnTrlList stored in table OBCQL_Query_Column
static String	PROPERTY_ORGANIZATION	Property organization stored in column AD_Org_ID in table OBCQL_Query_Column
static String	PROPERTY_REFERENCE	Property reference stored in column AD_Reference_ID in table OBCQL_Query_Column Help: The Reference indicates the type of reference field
static String	PROPERTY_REFERENCESEARCHKEY	Property referenceSearchKey stored in column AD_Reference_Value_ID in table OBCQL_Query_Column Help: The Reference Value indicates where the reference values are stored. It must be specified if the data type is Table or List.
static String	PROPERTY_SEQUENCENUMBER	Property sequenceNumber stored in column Seqno in table OBCQL_Query_Column Help: The Sequence indicates the order of records
static String	PROPERTY_SUMMARIZETYPE	Property summarizeType stored in column Summarize_Type in table OBCQL_Query_Column Help: Select the desired summarize option in case the column is numeric and it is desired to have the sum, average,..
static String	PROPERTY_TAB	Property tab stored in column AD_Tab_ID in table OBCQL_Query_Column Help: The Tab indicates a tab that displays within a window.
static String	PROPERTY_UPDATED	Property updated stored in column Updated in table OBCQL_Query_Column
static String	PROPERTY_UPDATEDBY	Property updatedBy stored in column Updatedby in table OBCQL_Query_Column
static String	PROPERTY_WHERECLAUSELEFTPART	Property whereClauseLeftPart stored in column Whereclause_Left_Part in table OBCQL_Query_Column Help: Left part of the where clause needed to filter by a value of this column on the maximized view.
static String	PROPERTY_WIDGETQUERY	Property widgetQuery stored in column OBCQL_Widget_Query_ID in table OBCQL_Query_Column Help: Identifies the HQL Query definitino of a widget class that implements the Query/List Superclass widget
static String	PROPERTY_WIDTH	Property width stored in column Width in table OBCQL_Query_Column Help: Width of the column in percentage. If the sum of the widths is higher than 100 the grid will adapt the values. For example, 3 columns with 100 width will take 33% of the grid width each.
static String	TABLE_NAME

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

ID

Constructor Summary

Constructors

Constructor	Description
OBCQL_QueryColumn()

Method Summary

Modifier and Type	Method	Description
Client	getClient()	Client field
String	getClientClass()
User	getCreatedBy()	Created by audit user
Date	getCreationDate()	Creation date of audit
String	getDisplayExpression()
String	getEntityName()
String	getId()
String	getIncludeIn()
String	getLinkExpression()
String	getName()
List<QueryColumnTrl>	getOBCQLQueryColumnTrlList()
Organization	getOrganization()	Gets organization field
Reference	getReference()
Reference	getReferenceSearchKey()
Long	getSequenceNumber()
String	getSummarizeType()
Tab	getTab()
Date	getUpdated()	Update date of audit
User	getUpdatedBy()	Update by audit user
String	getWhereClauseLeftPart()
OBCQL_WidgetQuery	getWidgetQuery()
Long	getWidth()
Boolean	isActive()	Gets active field
Boolean	isCanBeFiltered()
Boolean	isHasLink()
void	setActive(Boolean active)	Sets active field
void	setCanBeFiltered(Boolean canBeFiltered)
void	setClient(Client client)	Client field
void	setClientClass(String clientClass)
void	setCreatedBy(User createdBy)	Created by audit user
void	setCreationDate(Date creationDate)	Creation date of audit
void	setDisplayExpression(String displayExpression)
void	setHasLink(Boolean hasLink)
void	setId(String id)
void	setIncludeIn(String includeIn)
void	setLinkExpression(String linkExpression)
void	setName(String name)
void	setOBCQLQueryColumnTrlList(List<QueryColumnTrl> oBCQLQueryColumnTrlList)
void	setOrganization(Organization organization)	Sets organization field
void	setReference(Reference reference)
void	setReferenceSearchKey(Reference referenceSearchKey)
void	setSequenceNumber(Long sequenceNumber)
void	setSummarizeType(String summarizeType)
void	setTab(Tab tab)
void	setUpdated(Date updated)	Update date of audit
void	setUpdatedBy(User updatedBy)	Update by audit user
void	setWhereClauseLeftPart(String whereClauseLeftPart)
void	setWidgetQuery(OBCQL_WidgetQuery widgetQuery)
void	setWidth(Long width)

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 OBCQL_Query_Column_ID in table OBCQL_Query_Column
Help: Column of the defined query that it is desired to be shown or exported

See Also:

Constant Field Values

PROPERTY_CLIENT

public static final String PROPERTY_CLIENT

Property client stored in column AD_Client_ID in table OBCQL_Query_Column

See Also:

ClientEnabled, Constant Field Values

PROPERTY_ORGANIZATION

public static final String PROPERTY_ORGANIZATION

Property organization stored in column AD_Org_ID in table OBCQL_Query_Column

See Also:

OrganizationEnabled, Constant Field Values

PROPERTY_ACTIVE

public static final String PROPERTY_ACTIVE

Property active stored in column Isactive in table OBCQL_Query_Column

See Also:

ActiveEnabled, Constant Field Values

PROPERTY_CREATIONDATE

public static final String PROPERTY_CREATIONDATE

Property creationDate stored in column Created in table OBCQL_Query_Column

See Also:

Traceable, Constant Field Values

PROPERTY_CREATEDBY

public static final String PROPERTY_CREATEDBY

Property createdBy stored in column Createdby in table OBCQL_Query_Column

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATED

public static final String PROPERTY_UPDATED

Property updated stored in column Updated in table OBCQL_Query_Column

See Also:

Traceable, Constant Field Values

PROPERTY_UPDATEDBY

public static final String PROPERTY_UPDATEDBY

Property updatedBy stored in column Updatedby in table OBCQL_Query_Column

See Also:

Traceable, Constant Field Values

PROPERTY_WIDGETQUERY

public static final String PROPERTY_WIDGETQUERY

Property widgetQuery stored in column OBCQL_Widget_Query_ID in table OBCQL_Query_Column
Help: Identifies the HQL Query definitino of a widget class that implements the Query/List Superclass widget

See Also:

Constant Field Values

PROPERTY_DISPLAYEXPRESSION

public static final String PROPERTY_DISPLAYEXPRESSION

Property displayExpression stored in column Display_Expression in table OBCQL_Query_Column
Help: Alias of HQL query column to be shown

See Also:

Constant Field Values

PROPERTY_NAME

public static final String PROPERTY_NAME

Property name stored in column Name in table OBCQL_Query_Column

See Also:

Constant Field Values

PROPERTY_SUMMARIZETYPE

public static final String PROPERTY_SUMMARIZETYPE

Property summarizeType stored in column Summarize_Type in table OBCQL_Query_Column
Help: Select the desired summarize option in case the column is numeric and it is desired to have the sum, average,..

See Also:

Constant Field Values

PROPERTY_WIDTH

public static final String PROPERTY_WIDTH

Property width stored in column Width in table OBCQL_Query_Column
Help: Width of the column in percentage. If the sum of the widths is higher than 100 the grid will adapt the values. For example, 3 columns with 100 width will take 33% of the grid width each.

See Also:

Constant Field Values

PROPERTY_LINKEXPRESSION

public static final String PROPERTY_LINKEXPRESSION

Property linkExpression stored in column Link_Expression in table OBCQL_Query_Column
Help: Alias of the HQL Query column with the id required to built the link

See Also:

Constant Field Values

PROPERTY_SEQUENCENUMBER

public static final String PROPERTY_SEQUENCENUMBER

Property sequenceNumber stored in column Seqno in table OBCQL_Query_Column
Help: The Sequence indicates the order of records

See Also:

Constant Field Values

PROPERTY_REFERENCE

public static final String PROPERTY_REFERENCE

Property reference stored in column AD_Reference_ID in table OBCQL_Query_Column
Help: The Reference indicates the type of reference field

See Also:

Constant Field Values

PROPERTY_REFERENCESEARCHKEY

public static final String PROPERTY_REFERENCESEARCHKEY

Property referenceSearchKey stored in column AD_Reference_Value_ID in table OBCQL_Query_Column
Help: The Reference Value indicates where the reference values are stored. It must be specified if the data type is Table or List.

See Also:

Constant Field Values

PROPERTY_INCLUDEIN

public static final String PROPERTY_INCLUDEIN

Property includeIn stored in column Include_In in table OBCQL_Query_Column
Help: Sets the visibility of the column: - Widget view, column is shown on all cases. - Maximized view, column is shown only in maximized view and included in the exported file. - Exported file, column is only included in the exported file.

See Also:

Constant Field Values

PROPERTY_HASLINK

public static final String PROPERTY_HASLINK

Property hasLink stored in column Has_Link in table OBCQL_Query_Column
Help: Flag to set that the field of the grid will have a link

See Also:

Constant Field Values

PROPERTY_TAB

public static final String PROPERTY_TAB

Property tab stored in column AD_Tab_ID in table OBCQL_Query_Column
Help: The Tab indicates a tab that displays within a window.

See Also:

Constant Field Values

PROPERTY_CANBEFILTERED

public static final String PROPERTY_CANBEFILTERED

Property canBeFiltered stored in column Can_Be_Filtered in table OBCQL_Query_Column
Help: This flag sets whether it is possible to filter the grid by this column or not on maximized view. To be able to filter it is also needed to set on the HQL Code where clause the display expression between @ symbols that will be replaced on execution by the filter clause in case it is being filtered or "1=1" when it is not. For example: having the following HQL "select product.name as prodcutName from product". To be able to filter by product name it is needed to include a "where @productName@" in the where clause: "select product.name as prodcutName from product where @productName@"

See Also:

Constant Field Values

PROPERTY_WHERECLAUSELEFTPART

public static final String PROPERTY_WHERECLAUSELEFTPART

Property whereClauseLeftPart stored in column Whereclause_Left_Part in table OBCQL_Query_Column
Help: Left part of the where clause needed to filter by a value of this column on the maximized view.

See Also:

Constant Field Values

PROPERTY_CLIENTCLASS

public static final String PROPERTY_CLIENTCLASS

Property clientClass stored in column Clientclass in table OBCQL_Query_Column

See Also:

Constant Field Values

PROPERTY_OBCQLQUERYCOLUMNTRLLIST

public static final String PROPERTY_OBCQLQUERYCOLUMNTRLLIST

Property oBCQLQueryColumnTrlList stored in table OBCQL_Query_Column

See Also:

Constant Field Values

Constructor Detail

OBCQL_QueryColumn

public OBCQL_QueryColumn()

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

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

getWidgetQuery

public OBCQL_WidgetQuery getWidgetQuery()

See Also:

PROPERTY_WIDGETQUERY

setWidgetQuery

public void setWidgetQuery(OBCQL_WidgetQuery widgetQuery)

See Also:

PROPERTY_WIDGETQUERY

getDisplayExpression

public String getDisplayExpression()

See Also:

PROPERTY_DISPLAYEXPRESSION

setDisplayExpression

public void setDisplayExpression(String displayExpression)

See Also:

PROPERTY_DISPLAYEXPRESSION

getName

public String getName()

See Also:

PROPERTY_NAME

setName

public void setName(String name)

See Also:

PROPERTY_NAME

getSummarizeType

public String getSummarizeType()

See Also:

PROPERTY_SUMMARIZETYPE

setSummarizeType

public void setSummarizeType(String summarizeType)

See Also:

PROPERTY_SUMMARIZETYPE

getWidth

public Long getWidth()

See Also:

PROPERTY_WIDTH

setWidth

public void setWidth(Long width)

See Also:

PROPERTY_WIDTH

getLinkExpression

public String getLinkExpression()

See Also:

PROPERTY_LINKEXPRESSION

setLinkExpression

public void setLinkExpression(String linkExpression)

See Also:

PROPERTY_LINKEXPRESSION

getSequenceNumber

public Long getSequenceNumber()

See Also:

PROPERTY_SEQUENCENUMBER

setSequenceNumber

public void setSequenceNumber(Long sequenceNumber)

See Also:

PROPERTY_SEQUENCENUMBER

getReference

public Reference getReference()

See Also:

PROPERTY_REFERENCE

setReference

public void setReference(Reference reference)

See Also:

PROPERTY_REFERENCE

getReferenceSearchKey

public Reference getReferenceSearchKey()

See Also:

PROPERTY_REFERENCESEARCHKEY

setReferenceSearchKey

public void setReferenceSearchKey(Reference referenceSearchKey)

See Also:

PROPERTY_REFERENCESEARCHKEY

getIncludeIn

public String getIncludeIn()

See Also:

PROPERTY_INCLUDEIN

setIncludeIn

public void setIncludeIn(String includeIn)

See Also:

PROPERTY_INCLUDEIN

isHasLink

public Boolean isHasLink()

See Also:

PROPERTY_HASLINK

setHasLink

public void setHasLink(Boolean hasLink)

See Also:

PROPERTY_HASLINK

getTab

public Tab getTab()

See Also:

PROPERTY_TAB

setTab

public void setTab(Tab tab)

See Also:

PROPERTY_TAB

isCanBeFiltered

public Boolean isCanBeFiltered()

See Also:

PROPERTY_CANBEFILTERED

setCanBeFiltered

public void setCanBeFiltered(Boolean canBeFiltered)

See Also:

PROPERTY_CANBEFILTERED

getWhereClauseLeftPart

public String getWhereClauseLeftPart()

See Also:

PROPERTY_WHERECLAUSELEFTPART

setWhereClauseLeftPart

public void setWhereClauseLeftPart(String whereClauseLeftPart)

See Also:

PROPERTY_WHERECLAUSELEFTPART

getClientClass

public String getClientClass()

See Also:

PROPERTY_CLIENTCLASS

setClientClass

public void setClientClass(String clientClass)

See Also:

PROPERTY_CLIENTCLASS

getOBCQLQueryColumnTrlList

public List<QueryColumnTrl> getOBCQLQueryColumnTrlList()

See Also:

QueryColumnTrl

setOBCQLQueryColumnTrlList

public void setOBCQLQueryColumnTrlList(List<QueryColumnTrl> oBCQLQueryColumnTrlList)

See Also:

QueryColumnTrl