Package org.compiere.model

Class MField

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_Field

org.compiere.model.MField

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_AD_Field, I_Persistent, Evaluatee, ImmutablePOSupport

public class MField
extends X_AD_Field
implements ImmutablePOSupport

Field Model

Version:

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

Author:

Jorg Janke

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_AD_Field

ENTITYTYPE_AD_Reference_ID, ISALLOWCOPY_AD_Reference_ID, ISALLOWCOPY_No, ISALLOWCOPY_Yes, ISALWAYSUPDATEABLE_AD_Reference_ID, ISALWAYSUPDATEABLE_No, ISALWAYSUPDATEABLE_Yes, ISHTML_AD_Reference_ID, ISHTML_No, ISHTML_Yes, ISMANDATORY_AD_Reference_ID, ISMANDATORY_No, ISMANDATORY_Yes, ISSELECTIONCOLUMN_AD_Reference_ID, ISSELECTIONCOLUMN_No, ISSELECTIONCOLUMN_Yes, ISTOOLBARBUTTON_AD_Reference_ID, ISTOOLBARBUTTON_Both, ISTOOLBARBUTTON_Toolbar, ISTOOLBARBUTTON_Window, ISUPDATEABLE_AD_Reference_ID, ISUPDATEABLE_No, ISUPDATEABLE_Yes, OBSCURETYPE_AD_Reference_ID, OBSCURETYPE_ObscureAlphaNumericButFirstLast4, OBSCURETYPE_ObscureAlphaNumericButLast4, OBSCURETYPE_ObscureDigitsButFirstLast4, OBSCURETYPE_ObscureDigitsButLast4

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, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_Field

accessLevel, COLUMNNAME_AD_Chart_ID, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Column_ID, COLUMNNAME_AD_Field_ID, COLUMNNAME_AD_Field_UU, COLUMNNAME_AD_FieldGroup_ID, COLUMNNAME_AD_FieldStyle_ID, COLUMNNAME_AD_LabelStyle_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Reference_ID, COLUMNNAME_AD_Reference_Value_ID, COLUMNNAME_AD_Tab_ID, COLUMNNAME_AD_Val_Rule_ID, COLUMNNAME_AD_Val_Rule_Lookup_ID, COLUMNNAME_AlwaysUpdatableLogic, COLUMNNAME_ColumnSpan, COLUMNNAME_ColumnSQL, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_DefaultValue, COLUMNNAME_Description, COLUMNNAME_DisplayLength, COLUMNNAME_DisplayLogic, COLUMNNAME_EntityType, COLUMNNAME_Help, COLUMNNAME_Included_Tab_ID, COLUMNNAME_IsActive, COLUMNNAME_IsAdvancedField, COLUMNNAME_IsAllowCopy, COLUMNNAME_IsAlwaysUpdateable, COLUMNNAME_IsCentrallyMaintained, COLUMNNAME_IsDefaultFocus, COLUMNNAME_IsDisplayed, COLUMNNAME_IsDisplayedGrid, COLUMNNAME_IsEncrypted, COLUMNNAME_IsFieldOnly, COLUMNNAME_IsHeading, COLUMNNAME_IsHtml, COLUMNNAME_IsMandatory, COLUMNNAME_IsQuickEntry, COLUMNNAME_IsQuickForm, COLUMNNAME_IsReadOnly, COLUMNNAME_IsSameLine, COLUMNNAME_IsSelectionColumn, COLUMNNAME_IsToolbarButton, COLUMNNAME_IsUpdateable, COLUMNNAME_MandatoryLogic, COLUMNNAME_Name, COLUMNNAME_NumLines, COLUMNNAME_ObscureType, COLUMNNAME_Placeholder, COLUMNNAME_ReadOnlyLogic, COLUMNNAME_SeqNo, COLUMNNAME_SeqNoGrid, COLUMNNAME_SortNo, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, COLUMNNAME_VFormat, COLUMNNAME_XPosition, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MField(Properties ctx, int AD_Field_ID, String trxName)	Standard Constructor
MField(Properties ctx, String AD_Field_UU, String trxName)	UUID based Constructor
MField(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MField(Properties ctx, MField copy)	Copy Constructor
MField(Properties ctx, MField copy, String trxName)	Copy Constructor
MField(MField copy)	Copy Constructor
MField(MTab parent)	Parent Constructor
MField(MTab parent, MField from)	Copy Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	beforeSave(boolean newRecord)	Called before Save for Pre-Save Operation. Default implementation is nop, to be implemented in sub-classes that needed it.
static MField	get(int AD_Field_ID)	Get MField from cache
static MField	get(Properties ctx, int AD_Field_ID)
MField	markImmutable()	mark PO as immutable
void	setColumn(MColumn column)	Set Column Values

Methods inherited from class org.compiere.model.X_AD_Field

get_AccessLevel, getAD_Chart, getAD_Chart_ID, getAD_Column, getAD_Column_ID, getAD_Field_ID, getAD_Field_UU, getAD_FieldGroup, getAD_FieldGroup_ID, getAD_FieldStyle, getAD_FieldStyle_ID, getAD_LabelStyle, getAD_LabelStyle_ID, getAD_Reference, getAD_Reference_ID, getAD_Reference_Value, getAD_Reference_Value_ID, getAD_Tab, getAD_Tab_ID, getAD_Val_Rule, getAD_Val_Rule_ID, getAD_Val_Rule_Lookup, getAD_Val_Rule_Lookup_ID, getAlwaysUpdatableLogic, getColumnSpan, getColumnSQL, getDefaultValue, getDescription, getDisplayLength, getDisplayLogic, getEntityType, getHelp, getIncluded_Tab, getIncluded_Tab_ID, getIsAllowCopy, getIsAlwaysUpdateable, getIsHtml, getIsMandatory, getIsSelectionColumn, getIsToolbarButton, getIsUpdateable, getKeyNamePair, getMandatoryLogic, getName, getNumLines, getObscureType, getPlaceholder, getReadOnlyLogic, getSeqNo, getSeqNoGrid, getSortNo, getVFormat, getXPosition, initPO, isAdvancedField, isCentrallyMaintained, isDefaultFocus, isDisplayed, isDisplayedGrid, isEncrypted, isFieldOnly, isHeading, isQuickEntry, isQuickForm, isReadOnly, isSameLine, setAD_Chart_ID, setAD_Column_ID, setAD_Field_ID, setAD_Field_UU, setAD_FieldGroup_ID, setAD_FieldStyle_ID, setAD_LabelStyle_ID, setAD_Reference_ID, setAD_Reference_Value_ID, setAD_Tab_ID, setAD_Val_Rule_ID, setAD_Val_Rule_Lookup_ID, setAlwaysUpdatableLogic, setColumnSpan, setColumnSQL, setDefaultValue, setDescription, setDisplayLength, setDisplayLogic, setEntityType, setHelp, setIncluded_Tab_ID, setIsAdvancedField, setIsAllowCopy, setIsAlwaysUpdateable, setIsCentrallyMaintained, setIsDefaultFocus, setIsDisplayed, setIsDisplayedGrid, setIsEncrypted, setIsFieldOnly, setIsHeading, setIsHtml, setIsMandatory, setIsQuickEntry, setIsQuickForm, setIsReadOnly, setIsSameLine, setIsSelectionColumn, setIsToolbarButton, setIsUpdateable, setMandatoryLogic, setName, setNumLines, setObscureType, setPlaceholder, setReadOnlyLogic, setSeqNo, setSeqNoGrid, setSortNo, setVFormat, setXPosition, toString

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, 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_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_AD_Field

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Constructor Details

MField

public MField(Properties ctx,
 String AD_Field_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

AD_Field_UU - UUID key

trxName - Transaction

MField

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

Standard Constructor

Parameters:

ctx - context

AD_Field_ID - id

trxName - transaction

MField

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MField

public MField(MTab parent)

Parent Constructor

Parameters:

parent - parent

MField

public MField(MTab parent,
 MField from)

Copy Constructor

Parameters:

parent - parent

from - copy from

MField

public MField(MField copy)

Copy Constructor

Parameters:

copy -

MField

public MField(Properties ctx,
 MField copy)

Copy Constructor

Parameters:

ctx -

copy -

MField

public MField(Properties ctx,
 MField copy,
 String trxName)

Copy Constructor

Parameters:

ctx -

copy -

trxName -

Method Details

get

public static MField get(int AD_Field_ID)

Get MField from cache

Parameters:

AD_Field_ID -

Returns:

MField (immutable)

get

public static MField get(Properties ctx,
 int AD_Field_ID)

Parameters:

ctx - context

AD_Field_ID -

Returns:

Immutable instance of MField

setColumn

public void setColumn(MColumn column)

Set Column Values

Parameters:

column - column

beforeSave

protected boolean beforeSave(boolean newRecord)

Description copied from class: PO

Called before Save for Pre-Save Operation.
Default implementation is nop, to be implemented in sub-classes that needed it.

Overrides:

beforeSave in class PO

Parameters:

newRecord - true if it is a new record

Returns:

true if record can be saved

markImmutable

public MField markImmutable()

Description copied from interface: ImmutablePOSupport

mark PO as immutable

Specified by:

markImmutable in interface ImmutablePOSupport

Returns:

PO