org.compiere.intf
Interface ComponentImplIntf

All Known Implementing Classes:

SampleSearchComponentImpl, SampleTableComponentImpl

public interface ComponentImplIntf

This is the interface to implement when you want to create a custom component for a custom window.

Author:

gwu

Method Summary

ComponentVO	getComponentVO() Implement this method to populate and return a ComponentVO to describe the desired behavior for the component.
TableModel	getQueryResults(QueryVO queryVO, WindowImplIntf windowImpl, WindowCtx windowCtx, FieldVO fieldVO, int startRow, int rowCount, boolean countOnly, boolean asc, int sortCol) Implement this method to return the result set for this component.

Method Detail

getComponentVO

ComponentVO getComponentVO()

Implement this method to populate and return a ComponentVO to describe the desired behavior for the component.

The minimum fields in the ComponentVO that should be populated are:

• componentType
• name
• tableName
• fieldVOs

Returns:

The ComponentVO that describes the behavior of the implemented component.

getQueryResults

TableModel getQueryResults(QueryVO queryVO,
                           WindowImplIntf windowImpl,
                           WindowCtx windowCtx,
                           FieldVO fieldVO,
                           int startRow,
                           int rowCount,
                           boolean countOnly,
                           boolean asc,
                           int sortCol)

Implement this method to return the result set for this component.

Parameters:

queryVO - The QueryVO passed in from the client.

windowImpl - The WindowImplIntf that contains this component.

windowCtx - The WindowCtx client-side window context passed in from the client.

fieldVO - The FieldVO of to the window tab field that initiated window. This is used to to constrain the result set using the FieldVO's validationCode.

startRow - The zero-based starting row number.

rowCount - The number of rows of results to retrieve.

countOnly - Indicates whether only a record count is requested. If true, the TableModel returned should be populated with only a single row and single column containing the record count.

asc - If true, sort in ascending order. Otherwise, sort in descending order.

sortCol - The zero-based column number to perform the sort on.

Returns:

The TableModel containing the result set for tabular result set components, or null for SEARCH components.