Class PBEColumn

Object
  |
  +--PBEUnit
        |
        +--PBEAttribute
              |
              +--PBEField
                    |
                    +--PBEColumn

Direct Known Subclasses:

PBEConstantColumn, PBEReferenceColumn, PBESearchColumn

public class PBEColumn

extends PBEField

Description:

PBEColumn provides functionality to access columns of database tables in PrimeBase Enterprise Objects applications.

Examples:

 PBE:declareObject(
   "PBETable",
   "country",
   "pbedemo!Common.Popups",
   "id",
   "code");
 PBE:declareAttribute(
   "PBEColumn",
   "id");
 

In this example a PBETable object called "country" and a PBEColumn called "id" of this object are being declared.

This example can be found in the file "initdemo.pbt" of the "PBE Demo" module (approx. line 191).

Field Summary

protected PBESearchCondition

search

Fields inherited from class PBEAttribute

enabled, iAfter, iBefore, iOn, iStatus, iValue, name, object, visible

Constructor Summary

PBEColumn(PBEObject my_object, varchar name)

PBEColumn(PBEObject my_object, varchar name, varchar cond)

Method Summary

protected varchar	buildMatchCondition(varchar column, generic value)
varchar	getFromListTable()
varchar	getInsertStatus() The value returned here is determines whether the column should be inserted.
varchar	getKeyCondition(boolean for_update)
generic	getKeyValue()
generic	getNewValue() This is the value used when doing an update or insert on this column.
varchar	getSearchColumn()
varchar	getSearchCondition()
varchar	getSearchStatus() The value returned here determines whether the column should be in a search.
varchar	getSelectListColumn()
varchar	getStatus()
varchar	getUpdateColumn()
varchar	getUpdateSearchColumn()
varchar	getUpdateStatus() The value returned here determines whether the column should be updated.
generic	getValue(boolean is_edit, generic default_value)
boolean	isKeyColumn()
void	setCondition(varchar cond)
void	setStatus(generic result)
void	setValue(generic v, boolean is_first)
varchar	shouldDelete()
varchar	shouldInsert()
varchar	shouldUpdate()

Methods inherited from class PBEAttribute

afterInput, beforeInput, disable, doAfterInput, doBeforeInput, doOnOutput, enable, enabled, getValue, globalReference, hide, inputValue, onOutput, outputValue, prepareAction, setValue, show

Methods inherited from class PBEUnit

compileActions, compileConditions, prepareEvent

Field Detail

search

protected PBESearchCondition search

Constructor Detail

PBEColumn

public PBEColumn(PBEObject my_object,
                 varchar name)

PBEColumn

public PBEColumn(PBEObject my_object,
                 varchar name,
                 varchar cond)

Method Detail

setCondition

public void setCondition(varchar cond)

getValue

public generic getValue(boolean is_edit,
                        generic default_value)

Overrides:

getValue in class PBEField

setValue

public void setValue(generic v,
                     boolean is_first)

Overrides:

setValue in class PBEAttribute

getStatus

public varchar getStatus()

Overrides:

getStatus in class PBEAttribute

setStatus

public void setStatus(generic result)

Overrides:

setStatus in class PBEAttribute

getSearchColumn

public varchar getSearchColumn()

getUpdateSearchColumn

public varchar getUpdateSearchColumn()

getSelectListColumn

public varchar getSelectListColumn()

Overrides:

getSelectListColumn in class PBEField

getFromListTable

public varchar getFromListTable()

getUpdateColumn

public varchar getUpdateColumn()

getNewValue

public generic getNewValue()

This is the value used when doing an update or insert on this column. This value is also used when searching the column.

getKeyValue

public generic getKeyValue()

buildMatchCondition

protected varchar buildMatchCondition(varchar column,
                                      generic value)

isKeyColumn

public boolean isKeyColumn()

getKeyCondition

public varchar getKeyCondition(boolean for_update)

getSearchCondition

public varchar getSearchCondition()

getSearchStatus

public varchar getSearchStatus()

The value returned here determines whether the column should be in a search. Empty string means OK (do the search). $null means do not search, and non-empty string means ERROR (don't update).

getInsertStatus

public varchar getInsertStatus()

The value returned here is determines whether the column should be inserted.

getUpdateStatus

public varchar getUpdateStatus()

The value returned here determines whether the column should be updated. By default, key columns are not if the value has not changed.

shouldInsert

public varchar shouldInsert()

shouldUpdate

public varchar shouldUpdate()

shouldDelete

public varchar shouldDelete()