org.compiere.model
Class X_AD_Field

java.lang.Object
  org.compiere.model.PO
      org.compiere.model.X_AD_Field

All Implemented Interfaces:

Serializable, Comparator, I_AD_Field, I_Persistent, Evaluatee

Direct Known Subclasses:

MField

public class X_AD_Field
extends PO
implements I_AD_Field, I_Persistent

Generated Model for AD_Field

Version:

Release 3.5.2a - $Id$

Author:

Adempiere (generated)

See Also:

Serialized Form

Field Summary

static int	AD_REFERENCE_ID_AD_Reference_ID AD_Reference_ID AD_Reference_ID=1
static int	AD_REFERENCE_VALUE_ID_AD_Reference_ID AD_Reference_Value_ID AD_Reference_ID=4
static int	ENTITYTYPE_AD_Reference_ID EntityType AD_Reference_ID=389
static int	ISMANDATORY_AD_Reference_ID IsMandatory AD_Reference_ID=319
static String	ISMANDATORY_No No = N
static String	ISMANDATORY_Yes Yes = Y
static int	OBSCURETYPE_AD_Reference_ID ObscureType AD_Reference_ID=291
static String	OBSCURETYPE_ObscureAlphaNumericButFirstLast4 Obscure AlphaNumeric but first/last 4 = A44
static String	OBSCURETYPE_ObscureAlphaNumericButLast4 Obscure AlphaNumeric but last 4 = A04
static String	OBSCURETYPE_ObscureDigitsButFirstLast4 Obscure Digits but first/last 4 = 944
static String	OBSCURETYPE_ObscureDigitsButLast4 Obscure Digits but last 4 = 904

Fields inherited from class org.compiere.model.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, log, p_ctx, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_Field

accessLevel, COLUMNNAME_AD_Column_ID, COLUMNNAME_AD_Field_ID, COLUMNNAME_AD_FieldGroup_ID, COLUMNNAME_AD_Reference_ID, COLUMNNAME_AD_Reference_Value_ID, COLUMNNAME_AD_Tab_ID, COLUMNNAME_AD_Val_Rule_ID, COLUMNNAME_DefaultValue, COLUMNNAME_Description, COLUMNNAME_DisplayLength, COLUMNNAME_DisplayLogic, COLUMNNAME_EntityType, COLUMNNAME_Help, COLUMNNAME_InfoFactoryClass, COLUMNNAME_IsCentrallyMaintained, COLUMNNAME_IsDisplayed, COLUMNNAME_IsEncrypted, COLUMNNAME_IsFieldOnly, COLUMNNAME_IsHeading, COLUMNNAME_IsMandatory, COLUMNNAME_IsReadOnly, COLUMNNAME_IsSameLine, COLUMNNAME_Name, COLUMNNAME_ObscureType, COLUMNNAME_SeqNo, COLUMNNAME_SortNo, Model, Table_ID, Table_Name

Constructor Summary

X_AD_Field(Properties ctx, int AD_Field_ID, String trxName)
Standard Constructor

X_AD_Field(Properties ctx, ResultSet rs, String trxName)
Load Constructor

Method Summary

protected int	get_AccessLevel() AccessLevel
int	getAD_Column_ID() Get Column.
I_AD_Column	getAD_Column()
int	getAD_Field_ID() Get Field.
int	getAD_FieldGroup_ID() Get Field Group.
I_AD_FieldGroup	getAD_FieldGroup()
int	getAD_Reference_ID() Get Reference.
int	getAD_Reference_Value_ID() Get Reference Key.
int	getAD_Tab_ID() Get Tab.
I_AD_Tab	getAD_Tab()
int	getAD_Val_Rule_ID() Get Dynamic Validation.
I_AD_Val_Rule	getAD_Val_Rule()
String	getDefaultValue() Get Default Logic.
String	getDescription() Get Description.
int	getDisplayLength() Get Display Length.
String	getDisplayLogic() Get Display Logic.
String	getEntityType() Get Entity Type.
String	getHelp() Get Comment/Help.
String	getInfoFactoryClass() Get Info Factory Class.
String	getIsMandatory() Get Mandatory.
KeyNamePair	getKeyNamePair() Get Record ID/ColumnName
String	getName() Get Name.
String	getObscureType() Get Obscure.
int	getSeqNo() Get Sequence.
BigDecimal	getSortNo() Get Record Sort No.
protected POInfo	initPO(Properties ctx) Load Meta Data
boolean	isCentrallyMaintained() Get Centrally maintained.
boolean	isDisplayed() Get Displayed.
boolean	isEncrypted() Get Encrypted.
boolean	isFieldOnly() Get Field Only.
boolean	isHeading() Get Heading only.
boolean	isReadOnly() Get Read Only.
boolean	isSameLine() Get Same Line.
void	setAD_Column_ID(int AD_Column_ID) Set Column.
void	setAD_Field_ID(int AD_Field_ID) Set Field.
void	setAD_FieldGroup_ID(int AD_FieldGroup_ID) Set Field Group.
void	setAD_Reference_ID(int AD_Reference_ID) Set Reference.
void	setAD_Reference_Value_ID(int AD_Reference_Value_ID) Set Reference Key.
void	setAD_Tab_ID(int AD_Tab_ID) Set Tab.
void	setAD_Val_Rule_ID(int AD_Val_Rule_ID) Set Dynamic Validation.
void	setDefaultValue(String DefaultValue) Set Default Logic.
void	setDescription(String Description) Set Description.
void	setDisplayLength(int DisplayLength) Set Display Length.
void	setDisplayLogic(String DisplayLogic) Set Display Logic.
void	setEntityType(String EntityType) Set Entity Type.
void	setHelp(String Help) Set Comment/Help.
void	setInfoFactoryClass(String InfoFactoryClass) Set Info Factory Class.
void	setIsCentrallyMaintained(boolean IsCentrallyMaintained) Set Centrally maintained.
void	setIsDisplayed(boolean IsDisplayed) Set Displayed.
void	setIsEncrypted(boolean IsEncrypted) Set Encrypted.
void	setIsFieldOnly(boolean IsFieldOnly) Set Field Only.
void	setIsHeading(boolean IsHeading) Set Heading only.
void	setIsMandatory(String IsMandatory) Set Mandatory.
void	setIsReadOnly(boolean IsReadOnly) Set Read Only.
void	setIsSameLine(boolean IsSameLine) Set Same Line.
void	setName(String Name) Set Name.
void	setObscureType(String ObscureType) Set Obscure.
void	setSeqNo(int SeqNo) Set Sequence.
void	setSortNo(BigDecimal SortNo) Set Record Sort No.
String	toString() String representation

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, beforeSave, compare, copyValues, copyValues, createAttachment, delete_Accounting, delete_Tree, delete, delete, deleteEx, deleteEx, dump, dump, equals, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveEx, saveEx, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setDoc, setDocWorkflowMgr, setIsActive, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, unlock

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.compiere.model.I_Persistent

save

Field Detail

AD_REFERENCE_ID_AD_Reference_ID

public static final int AD_REFERENCE_ID_AD_Reference_ID

AD_Reference_ID AD_Reference_ID=1

See Also:

Constant Field Values

AD_REFERENCE_VALUE_ID_AD_Reference_ID

public static final int AD_REFERENCE_VALUE_ID_AD_Reference_ID

AD_Reference_Value_ID AD_Reference_ID=4

See Also:

Constant Field Values

ENTITYTYPE_AD_Reference_ID

public static final int ENTITYTYPE_AD_Reference_ID

EntityType AD_Reference_ID=389

See Also:

Constant Field Values

ISMANDATORY_AD_Reference_ID

public static final int ISMANDATORY_AD_Reference_ID

IsMandatory AD_Reference_ID=319

See Also:

Constant Field Values

ISMANDATORY_Yes

public static final String ISMANDATORY_Yes

Yes = Y

See Also:

Constant Field Values

ISMANDATORY_No

public static final String ISMANDATORY_No

No = N

See Also:

Constant Field Values

OBSCURETYPE_AD_Reference_ID

public static final int OBSCURETYPE_AD_Reference_ID

ObscureType AD_Reference_ID=291

See Also:

Constant Field Values

OBSCURETYPE_ObscureDigitsButLast4

public static final String OBSCURETYPE_ObscureDigitsButLast4

Obscure Digits but last 4 = 904

See Also:

Constant Field Values

OBSCURETYPE_ObscureDigitsButFirstLast4

public static final String OBSCURETYPE_ObscureDigitsButFirstLast4

Obscure Digits but first/last 4 = 944

See Also:

Constant Field Values

OBSCURETYPE_ObscureAlphaNumericButFirstLast4

public static final String OBSCURETYPE_ObscureAlphaNumericButFirstLast4

Obscure AlphaNumeric but first/last 4 = A44

See Also:

Constant Field Values

OBSCURETYPE_ObscureAlphaNumericButLast4

public static final String OBSCURETYPE_ObscureAlphaNumericButLast4

Obscure AlphaNumeric but last 4 = A04

See Also:

Constant Field Values

Constructor Detail

X_AD_Field

public X_AD_Field(Properties ctx,
                  int AD_Field_ID,
                  String trxName)

Standard Constructor

X_AD_Field

public X_AD_Field(Properties ctx,
                  ResultSet rs,
                  String trxName)

Load Constructor

Method Detail

get_AccessLevel

protected int get_AccessLevel()

AccessLevel

Specified by:

get_AccessLevel in class PO

Returns:

4 - System

initPO

protected POInfo initPO(Properties ctx)

Load Meta Data

Specified by:

initPO in class PO

Parameters:

ctx - context

Returns:

POInfo

toString

public String toString()

Description copied from class: PO

String representation

Overrides:

toString in class PO

Returns:

String representation

getAD_Column

public I_AD_Column getAD_Column()
                         throws Exception

Specified by:

getAD_Column in interface I_AD_Field

Throws:

Exception

setAD_Column_ID

public void setAD_Column_ID(int AD_Column_ID)

Set Column.

Specified by:

setAD_Column_ID in interface I_AD_Field

Parameters:

AD_Column_ID - Column in the table

getAD_Column_ID

public int getAD_Column_ID()

Get Column.

Specified by:

getAD_Column_ID in interface I_AD_Field

Returns:

Column in the table

getAD_FieldGroup

public I_AD_FieldGroup getAD_FieldGroup()
                                 throws Exception

Specified by:

getAD_FieldGroup in interface I_AD_Field

Throws:

Exception

setAD_FieldGroup_ID

public void setAD_FieldGroup_ID(int AD_FieldGroup_ID)

Set Field Group.

Specified by:

setAD_FieldGroup_ID in interface I_AD_Field

Parameters:

AD_FieldGroup_ID - Logical grouping of fields

getAD_FieldGroup_ID

public int getAD_FieldGroup_ID()

Get Field Group.

Specified by:

getAD_FieldGroup_ID in interface I_AD_Field

Returns:

Logical grouping of fields

setAD_Field_ID

public void setAD_Field_ID(int AD_Field_ID)

Set Field.

Specified by:

setAD_Field_ID in interface I_AD_Field

Parameters:

AD_Field_ID - Field on a database table

getAD_Field_ID

public int getAD_Field_ID()

Get Field.

Specified by:

getAD_Field_ID in interface I_AD_Field

Returns:

Field on a database table

setAD_Reference_ID

public void setAD_Reference_ID(int AD_Reference_ID)

Set Reference.

Specified by:

setAD_Reference_ID in interface I_AD_Field

Parameters:

AD_Reference_ID - System Reference and Validation

getAD_Reference_ID

public int getAD_Reference_ID()

Get Reference.

Specified by:

getAD_Reference_ID in interface I_AD_Field

Returns:

System Reference and Validation

setAD_Reference_Value_ID

public void setAD_Reference_Value_ID(int AD_Reference_Value_ID)

Set Reference Key.

Specified by:

setAD_Reference_Value_ID in interface I_AD_Field

Parameters:

AD_Reference_Value_ID - Required to specify, if data type is Table or List

getAD_Reference_Value_ID

public int getAD_Reference_Value_ID()

Get Reference Key.

Specified by:

getAD_Reference_Value_ID in interface I_AD_Field

Returns:

Required to specify, if data type is Table or List

getAD_Tab

public I_AD_Tab getAD_Tab()
                   throws Exception

Specified by:

getAD_Tab in interface I_AD_Field

Throws:

Exception

setAD_Tab_ID

public void setAD_Tab_ID(int AD_Tab_ID)

Set Tab.

Specified by:

setAD_Tab_ID in interface I_AD_Field

Parameters:

AD_Tab_ID - Tab within a Window

getAD_Tab_ID

public int getAD_Tab_ID()

Get Tab.

Specified by:

getAD_Tab_ID in interface I_AD_Field

Returns:

Tab within a Window

getAD_Val_Rule

public I_AD_Val_Rule getAD_Val_Rule()
                             throws Exception

Specified by:

getAD_Val_Rule in interface I_AD_Field

Throws:

Exception

setAD_Val_Rule_ID

public void setAD_Val_Rule_ID(int AD_Val_Rule_ID)

Set Dynamic Validation.

Specified by:

setAD_Val_Rule_ID in interface I_AD_Field

Parameters:

AD_Val_Rule_ID - Dynamic Validation Rule

getAD_Val_Rule_ID

public int getAD_Val_Rule_ID()

Get Dynamic Validation.

Specified by:

getAD_Val_Rule_ID in interface I_AD_Field

Returns:

Dynamic Validation Rule

setDefaultValue

public void setDefaultValue(String DefaultValue)

Set Default Logic.

Specified by:

setDefaultValue in interface I_AD_Field

Parameters:

DefaultValue - Default value hierarchy, separated by ;

getDefaultValue

public String getDefaultValue()

Get Default Logic.

Specified by:

getDefaultValue in interface I_AD_Field

Returns:

Default value hierarchy, separated by ;

setDescription

public void setDescription(String Description)

Set Description.

Specified by:

setDescription in interface I_AD_Field

Parameters:

Description - Optional short description of the record

getDescription

public String getDescription()

Get Description.

Specified by:

getDescription in interface I_AD_Field

Returns:

Optional short description of the record

setDisplayLength

public void setDisplayLength(int DisplayLength)

Set Display Length.

Specified by:

setDisplayLength in interface I_AD_Field

Parameters:

DisplayLength - Length of the display in characters

getDisplayLength

public int getDisplayLength()

Get Display Length.

Specified by:

getDisplayLength in interface I_AD_Field

Returns:

Length of the display in characters

setDisplayLogic

public void setDisplayLogic(String DisplayLogic)

Set Display Logic.

Specified by:

setDisplayLogic in interface I_AD_Field

Parameters:

DisplayLogic - If the Field is displayed, the result determines if the field is actually displayed

getDisplayLogic

public String getDisplayLogic()

Get Display Logic.

Specified by:

getDisplayLogic in interface I_AD_Field

Returns:

If the Field is displayed, the result determines if the field is actually displayed

setEntityType

public void setEntityType(String EntityType)

Set Entity Type.

Specified by:

setEntityType in interface I_AD_Field

Parameters:

EntityType - Dictionary Entity Type; Determines ownership and synchronization

getEntityType

public String getEntityType()

Get Entity Type.

Specified by:

getEntityType in interface I_AD_Field

Returns:

Dictionary Entity Type; Determines ownership and synchronization

setHelp

public void setHelp(String Help)

Set Comment/Help.

Specified by:

setHelp in interface I_AD_Field

Parameters:

Help - Comment or Hint

getHelp

public String getHelp()

Get Comment/Help.

Specified by:

getHelp in interface I_AD_Field

Returns:

Comment or Hint

setInfoFactoryClass

public void setInfoFactoryClass(String InfoFactoryClass)

Set Info Factory Class.

Specified by:

setInfoFactoryClass in interface I_AD_Field

Parameters:

InfoFactoryClass - Fully qualified class name that implements the InfoFactory interface

getInfoFactoryClass

public String getInfoFactoryClass()

Get Info Factory Class.

Specified by:

getInfoFactoryClass in interface I_AD_Field

Returns:

Fully qualified class name that implements the InfoFactory interface

setIsCentrallyMaintained

public void setIsCentrallyMaintained(boolean IsCentrallyMaintained)

Set Centrally maintained.

Specified by:

setIsCentrallyMaintained in interface I_AD_Field

Parameters:

IsCentrallyMaintained - Information maintained in System Element table

isCentrallyMaintained

public boolean isCentrallyMaintained()

Get Centrally maintained.

Specified by:

isCentrallyMaintained in interface I_AD_Field

Returns:

Information maintained in System Element table

setIsDisplayed

public void setIsDisplayed(boolean IsDisplayed)

Set Displayed.

Specified by:

setIsDisplayed in interface I_AD_Field

Parameters:

IsDisplayed - Determines, if this field is displayed

isDisplayed

public boolean isDisplayed()

Get Displayed.

Specified by:

isDisplayed in interface I_AD_Field

Returns:

Determines, if this field is displayed

setIsEncrypted

public void setIsEncrypted(boolean IsEncrypted)

Set Encrypted.

Specified by:

setIsEncrypted in interface I_AD_Field

Parameters:

IsEncrypted - Display or Storage is encrypted

isEncrypted

public boolean isEncrypted()

Get Encrypted.

Specified by:

isEncrypted in interface I_AD_Field

Returns:

Display or Storage is encrypted

setIsFieldOnly

public void setIsFieldOnly(boolean IsFieldOnly)

Set Field Only.

Specified by:

setIsFieldOnly in interface I_AD_Field

Parameters:

IsFieldOnly - Label is not displayed

isFieldOnly

public boolean isFieldOnly()

Get Field Only.

Specified by:

isFieldOnly in interface I_AD_Field

Returns:

Label is not displayed

setIsHeading

public void setIsHeading(boolean IsHeading)

Set Heading only.

Specified by:

setIsHeading in interface I_AD_Field

Parameters:

IsHeading - Field without Column - Only label is displayed

isHeading

public boolean isHeading()

Get Heading only.

Specified by:

isHeading in interface I_AD_Field

Returns:

Field without Column - Only label is displayed

setIsMandatory

public void setIsMandatory(String IsMandatory)

Set Mandatory.

Specified by:

setIsMandatory in interface I_AD_Field

Parameters:

IsMandatory - Data entry is required in this column

getIsMandatory

public String getIsMandatory()

Get Mandatory.

Specified by:

getIsMandatory in interface I_AD_Field

Returns:

Data entry is required in this column

setIsReadOnly

public void setIsReadOnly(boolean IsReadOnly)

Set Read Only.

Specified by:

setIsReadOnly in interface I_AD_Field

Parameters:

IsReadOnly - Field is read only

isReadOnly

public boolean isReadOnly()

Get Read Only.

Specified by:

isReadOnly in interface I_AD_Field

Returns:

Field is read only

setIsSameLine

public void setIsSameLine(boolean IsSameLine)

Set Same Line.

Specified by:

setIsSameLine in interface I_AD_Field

Parameters:

IsSameLine - Displayed on same line as previous field

isSameLine

public boolean isSameLine()

Get Same Line.

Specified by:

isSameLine in interface I_AD_Field

Returns:

Displayed on same line as previous field

setName

public void setName(String Name)

Set Name.

Specified by:

setName in interface I_AD_Field

Parameters:

Name - Alphanumeric identifier of the entity

getName

public String getName()

Get Name.

Specified by:

getName in interface I_AD_Field

Returns:

Alphanumeric identifier of the entity

getKeyNamePair

public KeyNamePair getKeyNamePair()

Get Record ID/ColumnName

Returns:

ID/ColumnName pair

setObscureType

public void setObscureType(String ObscureType)

Set Obscure.

Specified by:

setObscureType in interface I_AD_Field

Parameters:

ObscureType - Type of obscuring the data (limiting the display)

getObscureType

public String getObscureType()

Get Obscure.

Specified by:

getObscureType in interface I_AD_Field

Returns:

Type of obscuring the data (limiting the display)

setSeqNo

public void setSeqNo(int SeqNo)

Set Sequence.

Specified by:

setSeqNo in interface I_AD_Field

Parameters:

SeqNo - Method of ordering records; lowest number comes first

getSeqNo

public int getSeqNo()

Get Sequence.

Specified by:

getSeqNo in interface I_AD_Field

Returns:

Method of ordering records; lowest number comes first

setSortNo

public void setSortNo(BigDecimal SortNo)

Set Record Sort No.

Specified by:

setSortNo in interface I_AD_Field

Parameters:

SortNo - Determines in what order the records are displayed

getSortNo

public BigDecimal getSortNo()

Get Record Sort No.

Specified by:

getSortNo in interface I_AD_Field

Returns:

Determines in what order the records are displayed