org.compiere.vos
Class FieldVO

java.lang.Object
  org.compiere.vos.FieldVO

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GridFieldVO

public class FieldVO
extends Object
implements Serializable

Field Model Value Object

Version:

$Id: GridFieldVO.java,v 1.3 2006/07/30 00:58:04 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

int	AD_Column_ID Clumn ID
int	AD_Field_ID
int	AD_Process_ID Process
int	AD_Reference_ID
int	AD_Reference_Value_ID Reference Value
int	AD_Tab_ID AD_Tab_ID
int	AD_Table_ID Table ID
int	AD_Val_Rule_ID
int	AD_Window_ID AD_Winmdow_ID
String	ColumnName Column name
String	ColumnSQL Column sql
String	dateFormatPattern
String	DefaultValue Default Value
String	DefaultValue2 Process Parameter Value2
String	Description Description
int	DisplayLength Display Length
String	DisplayLogic Dislay Logic
int	displayType DisplayType
String	FieldGroup Field Group
int	FieldLength Field Length
String	Header Label
String	Help Help
int	hotKey
boolean	IsAlwaysUpdateable Always Updateable
boolean	isColumnAccess
boolean	IsDefaultFocus Default Focus
boolean	isDependentValue
boolean	IsDisplayed Displayed
boolean	IsEncryptedColumn Storage Encryption
boolean	IsEncryptedField Display Encryption
boolean	IsFieldOnly Field Only
boolean	IsHeading Heading Only
boolean	IsIdentifier Table ID
boolean	isImpactsUI
boolean	isImpactsUITab
boolean	isImpactsValue
boolean	IsKey PK
boolean	IsMandatoryUI Mandatory Entry
boolean	IsParent FK
boolean	isProcess Is Process Parameter
boolean	isQueryCriteria
boolean	isRange Process Parameter Range
boolean	IsReadOnly Read Only
boolean	IsSameLine Same Line
boolean	IsSelectionColumn Find Selection
boolean	IsTextSearch Field Only
boolean	IsTranslated
boolean	IsUpdateable Updateable
boolean	IsVirtualColumn
String	label
ListBoxVO	listBoxVO
static CompiereLogger	log
String	mandatoryLogic
static int	MAX_DISPLAY_LENGTH
int	mrSeqNo
String	name Label
String	numberFormatPattern
String	ObscureType Display Obscure
String	ReadOnlyLogic Read Only Logic
String	selectClause
int	seqNo
int	SortNo Order By
String	tableName
int	TabNo Tab No
boolean	tabReadOnly Is the Tab Read Only
String	ValidationCode Lookup Validation code
String	ValueMax Max.
String	ValueMin Min.
String	VFormat Format enforcement
int	WindowNo Window No

Constructor Summary

FieldVO()

FieldVO(String columnName, String name, int displayType)

FieldVO(String columnName, String name, int displayType, boolean isMandatoryUI)

FieldVO(String columnName, String name, String colSQL, int displayType, boolean readOnly)

FieldVO(String columnName, String name, String colSQL, int displayType, boolean readOnly, boolean isDisplayed, boolean isKey)

FieldVO(String columnName, String name, String colSQL, int displayType, boolean readOnly, boolean isDisplayed, boolean isKey, boolean isMandatoryUI)

Method Summary

boolean	canDisplay()
FieldVO	copySearch()
FieldVO	copySearchAdvanced()
static String	getToColumnName(String columnName)
boolean	hasDisplayLogic()
boolean	hasReadOnlyLogic()
boolean	isDisplayed(Evaluatee eval) Field is Displayed
boolean	isEditable(Ctx ctx, Evaluatee eval, boolean tabReadOnly, boolean rowReadOnly, String tabLinkColumn, boolean inserting) Is it Editable - checks IsActive, IsUpdateable, and isDisplayed
boolean	isMandatory(Evaluatee eval)
int	maxDisplayLength()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final CompiereLogger log

MAX_DISPLAY_LENGTH

public static final int MAX_DISPLAY_LENGTH

See Also:

Constant Field Values

Help

public String Help

Help

Description

public String Description

Description

WindowNo

public int WindowNo

Window No

TabNo

public int TabNo

Tab No

AD_Window_ID

public int AD_Window_ID

AD_Winmdow_ID

AD_Tab_ID

public int AD_Tab_ID

AD_Tab_ID

tabReadOnly

public boolean tabReadOnly

Is the Tab Read Only

isProcess

public boolean isProcess

Is Process Parameter

ColumnName

public String ColumnName

Column name

ColumnSQL

public String ColumnSQL

Column sql

Header

public String Header

Label

displayType

public int displayType

DisplayType

AD_Table_ID

public int AD_Table_ID

Table ID

AD_Column_ID

public int AD_Column_ID

Clumn ID

DisplayLength

public int DisplayLength

Display Length

IsSameLine

public boolean IsSameLine

Same Line

IsDisplayed

public boolean IsDisplayed

Displayed

DisplayLogic

public String DisplayLogic

Dislay Logic

DefaultValue

public String DefaultValue

Default Value

IsMandatoryUI

public boolean IsMandatoryUI

Mandatory Entry

IsReadOnly

public boolean IsReadOnly

Read Only

IsUpdateable

public boolean IsUpdateable

Updateable

IsAlwaysUpdateable

public boolean IsAlwaysUpdateable

Always Updateable

IsHeading

public boolean IsHeading

Heading Only

IsFieldOnly

public boolean IsFieldOnly

Field Only

IsEncryptedField

public boolean IsEncryptedField

Display Encryption

IsEncryptedColumn

public boolean IsEncryptedColumn

Storage Encryption

IsSelectionColumn

public boolean IsSelectionColumn

Find Selection

SortNo

public int SortNo

Order By

FieldLength

public int FieldLength

Field Length

VFormat

public String VFormat

Format enforcement

ValueMin

public String ValueMin

Min. Value

ValueMax

public String ValueMax

Max. Value

FieldGroup

public String FieldGroup

Field Group

IsKey

public boolean IsKey

PK

IsParent

public boolean IsParent

FK

AD_Process_ID

public int AD_Process_ID

Process

ReadOnlyLogic

public String ReadOnlyLogic

Read Only Logic

ObscureType

public String ObscureType

Display Obscure

IsDefaultFocus

public boolean IsDefaultFocus

Default Focus

IsTextSearch

public boolean IsTextSearch

Field Only

ValidationCode

public String ValidationCode

Lookup Validation code

AD_Reference_Value_ID

public int AD_Reference_Value_ID

Reference Value

isRange

public boolean isRange

Process Parameter Range

DefaultValue2

public String DefaultValue2

Process Parameter Value2

AD_Field_ID

public int AD_Field_ID

AD_Reference_ID

public int AD_Reference_ID

AD_Val_Rule_ID

public int AD_Val_Rule_ID

name

public String name

Label

label

public String label

seqNo

public int seqNo

IsIdentifier

public boolean IsIdentifier

Table ID

IsTranslated

public boolean IsTranslated

mandatoryLogic

public String mandatoryLogic

IsVirtualColumn

public boolean IsVirtualColumn

tableName

public String tableName

hotKey

public int hotKey

mrSeqNo

public int mrSeqNo

listBoxVO

public ListBoxVO listBoxVO

isImpactsValue

public boolean isImpactsValue

isImpactsUITab

public boolean isImpactsUITab

isDependentValue

public boolean isDependentValue

isImpactsUI

public boolean isImpactsUI

isQueryCriteria

public boolean isQueryCriteria

selectClause

public String selectClause

numberFormatPattern

public String numberFormatPattern

dateFormatPattern

public String dateFormatPattern

isColumnAccess

public boolean isColumnAccess

Constructor Detail

FieldVO

public FieldVO(String columnName,
               String name,
               int displayType)

FieldVO

public FieldVO(String columnName,
               String name,
               int displayType,
               boolean isMandatoryUI)

FieldVO

public FieldVO(String columnName,
               String name,
               String colSQL,
               int displayType,
               boolean readOnly)

FieldVO

public FieldVO(String columnName,
               String name,
               String colSQL,
               int displayType,
               boolean readOnly,
               boolean isDisplayed,
               boolean isKey)

FieldVO

public FieldVO(String columnName,
               String name,
               String colSQL,
               int displayType,
               boolean readOnly,
               boolean isDisplayed,
               boolean isKey,
               boolean isMandatoryUI)

FieldVO

public FieldVO()

Method Detail

maxDisplayLength

public int maxDisplayLength()

hasDisplayLogic

public boolean hasDisplayLogic()

canDisplay

public boolean canDisplay()

hasReadOnlyLogic

public boolean hasReadOnlyLogic()

isEditable

public boolean isEditable(Ctx ctx,
                          Evaluatee eval,
                          boolean tabReadOnly,
                          boolean rowReadOnly,
                          String tabLinkColumn,
                          boolean inserting)

Is it Editable - checks IsActive, IsUpdateable, and isDisplayed

Parameters:

ctx - optional checks context for Active, IsProcessed, LinkColumn

WindowNo - window

tab - sibling tab

inserting -

Returns:

true, if editable

isMandatory

public boolean isMandatory(Evaluatee eval)

isDisplayed

public boolean isDisplayed(Evaluatee eval)

Field is Displayed

Parameters:

ctx - optional checks context

Returns:

true if displayed

copySearch

public FieldVO copySearch()

copySearchAdvanced

public FieldVO copySearchAdvanced()

getToColumnName

public static String getToColumnName(String columnName)

toString

public String toString()

Overrides:

toString in class Object