org.compiere.framework
Class POInfo

java.lang.Object
  org.compiere.framework.POInfo

All Implemented Interfaces:

Serializable

public class POInfo
extends Object
implements Serializable

Persistet Object Info. Provides structural information

Version:

$Id: POInfo.java,v 1.2 2006/07/30 00:58:37 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Method Summary

String	getAccessLevel() Get Table Access Level
int	getAD_Table_ID() Get AD_Table_ID
protected POInfoColumn	getColumn(int index) Get Column
protected POInfoColumn	getColumn(String columnName) Get Column
int	getColumnAD_Reference_ID(int index) Get Reference Value
Class<?>	getColumnClass(int index) Get Column Class
int	getColumnCount() Get ColumnCount
String	getColumnDescription(int index) Get Column Description
int	getColumnDisplayType(int index) Get Column Display Type
int	getColumnIndex(int AD_Column_ID) Get Column Index
int	getColumnIndex(String ColumnName) Get Column Index
String	getColumnLabel(int index) Get Column Label
Lookup	getColumnLookup(int index) Get Lookup
String	getColumnName(int index) Get Column Name
String	getColumnSQL(int index) Get Column SQL or Column Name
String	getDefaultLogic(int index) Get Column Default Logic
int	getFieldLength(int index) Get Column FieldLength
int	getFieldLength(String columnName) Get Column FieldLength
static POInfo	getPOInfo(Ctx ctx, int AD_Table_ID) POInfo Factory
String	getTableName() Get Table Name
boolean	hasKeyColumn() Table has a Key Column
boolean	isColumnLookup(int index) Is Lookup Column
boolean	isColumnMandatory(int index) Is Column Mandatory
boolean	isColumnParent(int index) Is Column Parent
boolean	isColumnTranslated(int index) Is Column Translated
boolean	isColumnUpdateable(int index) Is Column Updateable
boolean	isEncrypted(int index) Is Column (data) Encrypted
boolean	isKey(int index) Is Column Key
boolean	isTranslated() Is Table Translated
boolean	isVirtualColumn(int index) Is Column Virtal?
void	setColumnUpdateable(int index, boolean updateable) Set Column Updateable
void	setUpdateable(boolean updateable) Set all columns updateable
String	toString() String representation
String	toString(int index) String representation for index
String	validate(int index, Object value) Validate Content

Methods inherited from class java.lang.Object

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

Method Detail

getPOInfo

public static POInfo getPOInfo(Ctx ctx,
                               int AD_Table_ID)

POInfo Factory

Parameters:

ctx - context

AD_Table_ID - AD_Table_ID

Returns:

POInfo

toString

public String toString()

String representation

Overrides:

toString in class Object

Returns:

String Representation

toString

public String toString(int index)

String representation for index

Parameters:

index - column index

Returns:

String Representation

getTableName

public String getTableName()

Get Table Name

Returns:

Table Name

getAD_Table_ID

public int getAD_Table_ID()

Get AD_Table_ID

Returns:

AD_Table_ID

hasKeyColumn

public boolean hasKeyColumn()

Table has a Key Column

Returns:

true if has a key column

getAccessLevel

public String getAccessLevel()

Get Table Access Level

Returns:

Table.ACCESS..

getColumnCount

public int getColumnCount()

Get ColumnCount

Returns:

column count

getColumnIndex

public int getColumnIndex(String ColumnName)

Get Column Index

Parameters:

ColumnName - column name

Returns:

index of column with ColumnName or -1 if not found

getColumnIndex

public int getColumnIndex(int AD_Column_ID)

Get Column Index

Parameters:

AD_Column_ID - column

Returns:

index of column with ColumnName or -1 if not found

getColumn

protected POInfoColumn getColumn(String columnName)

Get Column

Parameters:

columnName - column name

Returns:

column

getColumn

protected POInfoColumn getColumn(int index)

Get Column

Parameters:

index - index

Returns:

column

getColumnName

public String getColumnName(int index)

Get Column Name

Parameters:

index - index

Returns:

ColumnName column name

getColumnSQL

public String getColumnSQL(int index)

Get Column SQL or Column Name

Parameters:

index - index

Returns:

ColumnSQL column sql or name

isVirtualColumn

public boolean isVirtualColumn(int index)

Is Column Virtal?

Parameters:

index - index

Returns:

true if column is virtual

getColumnLabel

public String getColumnLabel(int index)

Get Column Label

Parameters:

index - index

Returns:

column label

getColumnDescription

public String getColumnDescription(int index)

Get Column Description

Parameters:

index - index

Returns:

column description

getColumnClass

public Class<?> getColumnClass(int index)

Get Column Class

Parameters:

index - index

Returns:

Class

getColumnDisplayType

public int getColumnDisplayType(int index)

Get Column Display Type

Parameters:

index - index

Returns:

DisplayType

getDefaultLogic

public String getDefaultLogic(int index)

Get Column Default Logic

Parameters:

index - index

Returns:

Default Logic

isColumnMandatory

public boolean isColumnMandatory(int index)

Is Column Mandatory

Parameters:

index - index

Returns:

true if column mandatory

isColumnUpdateable

public boolean isColumnUpdateable(int index)

Is Column Updateable

Parameters:

index - index

Returns:

true if column updateable

setColumnUpdateable

public void setColumnUpdateable(int index,
                                boolean updateable)

Set Column Updateable

Parameters:

index - index

updateable - column updateable

setUpdateable

public void setUpdateable(boolean updateable)

Set all columns updateable

Parameters:

updateable - updateable

isColumnLookup

public boolean isColumnLookup(int index)

Is Lookup Column

Parameters:

index - index

Returns:

true if it is a lookup column

getColumnLookup

public Lookup getColumnLookup(int index)

Get Lookup

Parameters:

index - index

Returns:

Lookup

isKey

public boolean isKey(int index)

Is Column Key

Parameters:

index - index

Returns:

true if column is the key

isColumnParent

public boolean isColumnParent(int index)

Is Column Parent

Parameters:

index - index

Returns:

true if column is a Parent

isColumnTranslated

public boolean isColumnTranslated(int index)

Is Column Translated

Parameters:

index - index

Returns:

true if column is translated

isTranslated

public boolean isTranslated()

Is Table Translated

Returns:

true if table is translated

isEncrypted

public boolean isEncrypted(int index)

Is Column (data) Encrypted

Parameters:

index - index

Returns:

true if column is encrypted

getFieldLength

public int getFieldLength(int index)

Get Column FieldLength

Parameters:

index - index

Returns:

field length or 0

getFieldLength

public int getFieldLength(String columnName)

Get Column FieldLength

Parameters:

columnName -

Returns:

field length or 0

getColumnAD_Reference_ID

public int getColumnAD_Reference_ID(int index)

Get Reference Value

Parameters:

index - column index

Returns:

AD_Reference_Value_ID

validate

public String validate(int index,
                       Object value)

Validate Content

Parameters:

index - index

value - new Value

Returns:

null if all valid otherwise error message