Package org.compiere.model

Class X_AD_Column

    • Field Detail

      • ENTITYTYPE_AD_Reference_ID

        public static final int ENTITYTYPE_AD_Reference_ID
        EntityType AD_Reference_ID=389
        See Also:
        Constant Field Values

      • FKCONSTRAINTTYPE_AD_Reference_ID

        public static final int FKCONSTRAINTTYPE_AD_Reference_ID
        FKConstraintType AD_Reference_ID=200075
        See Also:
        Constant Field Values

      • FKCONSTRAINTTYPE_DoNotCreate

        public static final String FKCONSTRAINTTYPE_DoNotCreate
        Do Not Create = D
        See Also:
        Constant Field Values

      • FKCONSTRAINTTYPE_ModelCascade

        public static final String FKCONSTRAINTTYPE_ModelCascade
        Model Cascade = M
        See Also:
        Constant Field Values

      • ISENCRYPTED_AD_Reference_ID

        public static final int ISENCRYPTED_AD_Reference_ID
        IsEncrypted AD_Reference_ID=354
        See Also:
        Constant Field Values

      • ISTOOLBARBUTTON_AD_Reference_ID

        public static final int ISTOOLBARBUTTON_AD_Reference_ID
        IsToolbarButton AD_Reference_ID=200099
        See Also:
        Constant Field Values

    • Constructor Detail

      • X_AD_Column

        public X_AD_Column​(Properties ctx,
                   int AD_Column_ID,
                   String trxName)
        Standard 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

      • setAD_Chart_ID

        public void setAD_Chart_ID​(int AD_Chart_ID)
        Set Chart.
        Specified by:
        setAD_Chart_ID in interface I_AD_Column
        Parameters:
        AD_Chart_ID - Chart

      • getAD_Chart_ID

        public int getAD_Chart_ID()
        Get Chart.
        Specified by:
        getAD_Chart_ID in interface I_AD_Column
        Returns:
        Chart

      • setAD_Column_ID

        public void setAD_Column_ID​(int AD_Column_ID)
        Set Column.
        Specified by:
        setAD_Column_ID in interface I_AD_Column
        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_Column
        Returns:
        Column in the table

      • setAD_Column_UU

        public void setAD_Column_UU​(String AD_Column_UU)
        Set AD_Column_UU.
        Specified by:
        setAD_Column_UU in interface I_AD_Column
        Parameters:
        AD_Column_UU - AD_Column_UU

      • setAD_Element_ID

        public void setAD_Element_ID​(int AD_Element_ID)
        Set System Element.
        Specified by:
        setAD_Element_ID in interface I_AD_Column
        Parameters:
        AD_Element_ID - System Element enables the central maintenance of column description and help.

      • getAD_Element_ID

        public int getAD_Element_ID()
        Get System Element.
        Specified by:
        getAD_Element_ID in interface I_AD_Column
        Returns:
        System Element enables the central maintenance of column description and help.

      • setAD_Process_ID

        public void setAD_Process_ID​(int AD_Process_ID)
        Set Process.
        Specified by:
        setAD_Process_ID in interface I_AD_Column
        Parameters:
        AD_Process_ID - Process or Report

      • getAD_Process_ID

        public int getAD_Process_ID()
        Get Process.
        Specified by:
        getAD_Process_ID in interface I_AD_Column
        Returns:
        Process or Report

      • setAD_Reference_ID

        public void setAD_Reference_ID​(int AD_Reference_ID)
        Set Reference.
        Specified by:
        setAD_Reference_ID in interface I_AD_Column
        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_Column
        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_Column
        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_Column
        Returns:
        Required to specify, if data type is Table or List

      • setAD_Table_ID

        public void setAD_Table_ID​(int AD_Table_ID)
        Set Table.
        Specified by:
        setAD_Table_ID in interface I_AD_Column
        Parameters:
        AD_Table_ID - Database Table information

      • getAD_Table_ID

        public int getAD_Table_ID()
        Get Table.
        Specified by:
        getAD_Table_ID in interface I_AD_Column
        Returns:
        Database Table information

      • 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_Column
        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_Column
        Returns:
        Dynamic Validation Rule

      • setAD_Val_Rule_Lookup_ID

        public void setAD_Val_Rule_Lookup_ID​(int AD_Val_Rule_Lookup_ID)
        Set Dynamic Validation (Lookup).
        Specified by:
        setAD_Val_Rule_Lookup_ID in interface I_AD_Column
        Parameters:
        AD_Val_Rule_Lookup_ID - Override Dynamic Validation Rule for Lookup Window

      • getAD_Val_Rule_Lookup_ID

        public int getAD_Val_Rule_Lookup_ID()
        Get Dynamic Validation (Lookup).
        Specified by:
        getAD_Val_Rule_Lookup_ID in interface I_AD_Column
        Returns:
        Override Dynamic Validation Rule for Lookup Window

      • setCallout

        public void setCallout​(String Callout)
        Set Callout.
        Specified by:
        setCallout in interface I_AD_Column
        Parameters:
        Callout - Fully qualified class names and method - separated by semicolons

      • getCallout

        public String getCallout()
        Get Callout.
        Specified by:
        getCallout in interface I_AD_Column
        Returns:
        Fully qualified class names and method - separated by semicolons

      • setColumnName

        public void setColumnName​(String ColumnName)
        Set DB Column Name.
        Specified by:
        setColumnName in interface I_AD_Column
        Parameters:
        ColumnName - Name of the column in the database

      • getColumnName

        public String getColumnName()
        Get DB Column Name.
        Specified by:
        getColumnName in interface I_AD_Column
        Returns:
        Name of the column in the database

      • getKeyNamePair

        public KeyNamePair getKeyNamePair()
        Get Record ID/ColumnName
        Returns:
        ID/ColumnName pair

      • setColumnSQL

        public void setColumnSQL​(String ColumnSQL)
        Set Column SQL.
        Specified by:
        setColumnSQL in interface I_AD_Column
        Parameters:
        ColumnSQL - Virtual Column (r/o)

      • getColumnSQL

        public String getColumnSQL()
        Get Column SQL.
        Specified by:
        getColumnSQL in interface I_AD_Column
        Returns:
        Virtual Column (r/o)

      • setDefaultValue

        public void setDefaultValue​(String DefaultValue)
        Set Default Logic.
        Specified by:
        setDefaultValue in interface I_AD_Column
        Parameters:
        DefaultValue - Default value hierarchy, separated by ;

      • getDefaultValue

        public String getDefaultValue()
        Get Default Logic.
        Specified by:
        getDefaultValue in interface I_AD_Column
        Returns:
        Default value hierarchy, separated by ;

      • setDescription

        public void setDescription​(String Description)
        Set Description.
        Specified by:
        setDescription in interface I_AD_Column
        Parameters:
        Description - Optional short description of the record

      • getDescription

        public String getDescription()
        Get Description.
        Specified by:
        getDescription in interface I_AD_Column
        Returns:
        Optional short description of the record

      • setEntityType

        public void setEntityType​(String EntityType)
        Set Entity Type.
        Specified by:
        setEntityType in interface I_AD_Column
        Parameters:
        EntityType - Dictionary Entity Type; Determines ownership and synchronization

      • getEntityType

        public String getEntityType()
        Get Entity Type.
        Specified by:
        getEntityType in interface I_AD_Column
        Returns:
        Dictionary Entity Type; Determines ownership and synchronization

      • setFieldLength

        public void setFieldLength​(int FieldLength)
        Set Length.
        Specified by:
        setFieldLength in interface I_AD_Column
        Parameters:
        FieldLength - Length of the column in the database

      • getFieldLength

        public int getFieldLength()
        Get Length.
        Specified by:
        getFieldLength in interface I_AD_Column
        Returns:
        Length of the column in the database

      • setFKConstraintName

        public void setFKConstraintName​(String FKConstraintName)
        Set Constraint Name.
        Specified by:
        setFKConstraintName in interface I_AD_Column
        Parameters:
        FKConstraintName - Constraint Name

      • setFKConstraintType

        public void setFKConstraintType​(String FKConstraintType)
        Set Constraint Type.
        Specified by:
        setFKConstraintType in interface I_AD_Column
        Parameters:
        FKConstraintType - Constraint Type

      • setFormatPattern

        public void setFormatPattern​(String FormatPattern)
        Set Format Pattern.
        Specified by:
        setFormatPattern in interface I_AD_Column
        Parameters:
        FormatPattern - The pattern used to format a number or date.

      • getFormatPattern

        public String getFormatPattern()
        Get Format Pattern.
        Specified by:
        getFormatPattern in interface I_AD_Column
        Returns:
        The pattern used to format a number or date.

      • setHelp

        public void setHelp​(String Help)
        Set Comment/Help.
        Specified by:
        setHelp in interface I_AD_Column
        Parameters:
        Help - Comment or Hint

      • getHelp

        public String getHelp()
        Get Comment/Help.
        Specified by:
        getHelp in interface I_AD_Column
        Returns:
        Comment or Hint

      • setIsAllowCopy

        public void setIsAllowCopy​(boolean IsAllowCopy)
        Set Allow Copy.
        Specified by:
        setIsAllowCopy in interface I_AD_Column
        Parameters:
        IsAllowCopy - Determine if a column must be copied when pushing the button to copy record

      • isAllowCopy

        public boolean isAllowCopy()
        Get Allow Copy.
        Specified by:
        isAllowCopy in interface I_AD_Column
        Returns:
        Determine if a column must be copied when pushing the button to copy record

      • setIsAllowLogging

        public void setIsAllowLogging​(boolean IsAllowLogging)
        Set Allow Logging.
        Specified by:
        setIsAllowLogging in interface I_AD_Column
        Parameters:
        IsAllowLogging - Determine if a column must be recorded into the change log

      • isAllowLogging

        public boolean isAllowLogging()
        Get Allow Logging.
        Specified by:
        isAllowLogging in interface I_AD_Column
        Returns:
        Determine if a column must be recorded into the change log

      • setIsAlwaysUpdateable

        public void setIsAlwaysUpdateable​(boolean IsAlwaysUpdateable)
        Set Always Updatable.
        Specified by:
        setIsAlwaysUpdateable in interface I_AD_Column
        Parameters:
        IsAlwaysUpdateable - The column is always updateable, even if the record is not active or processed

      • isAlwaysUpdateable

        public boolean isAlwaysUpdateable()
        Get Always Updatable.
        Specified by:
        isAlwaysUpdateable in interface I_AD_Column
        Returns:
        The column is always updateable, even if the record is not active or processed

      • setIsAutocomplete

        public void setIsAutocomplete​(boolean IsAutocomplete)
        Set Autocomplete.
        Specified by:
        setIsAutocomplete in interface I_AD_Column
        Parameters:
        IsAutocomplete - Automatic completion for textfields

      • isAutocomplete

        public boolean isAutocomplete()
        Get Autocomplete.
        Specified by:
        isAutocomplete in interface I_AD_Column
        Returns:
        Automatic completion for textfields

      • setIsEncrypted

        public void setIsEncrypted​(String IsEncrypted)
        Set Encrypted.
        Specified by:
        setIsEncrypted in interface I_AD_Column
        Parameters:
        IsEncrypted - Display or Storage is encrypted

      • getIsEncrypted

        public String getIsEncrypted()
        Get Encrypted.
        Specified by:
        getIsEncrypted in interface I_AD_Column
        Returns:
        Display or Storage is encrypted

      • setIsHtml

        public void setIsHtml​(boolean IsHtml)
        Set HTML.
        Specified by:
        setIsHtml in interface I_AD_Column
        Parameters:
        IsHtml - Text has HTML tags

      • isHtml

        public boolean isHtml()
        Get HTML.
        Specified by:
        isHtml in interface I_AD_Column
        Returns:
        Text has HTML tags

      • setIsIdentifier

        public void setIsIdentifier​(boolean IsIdentifier)
        Set Identifier.
        Specified by:
        setIsIdentifier in interface I_AD_Column
        Parameters:
        IsIdentifier - This column is part of the record identifier

      • isIdentifier

        public boolean isIdentifier()
        Get Identifier.
        Specified by:
        isIdentifier in interface I_AD_Column
        Returns:
        This column is part of the record identifier

      • setIsKey

        public void setIsKey​(boolean IsKey)
        Set Key column.
        Specified by:
        setIsKey in interface I_AD_Column
        Parameters:
        IsKey - This column is the key in this table

      • isKey

        public boolean isKey()
        Get Key column.
        Specified by:
        isKey in interface I_AD_Column
        Returns:
        This column is the key in this table

      • setIsMandatory

        public void setIsMandatory​(boolean IsMandatory)
        Set Mandatory.
        Specified by:
        setIsMandatory in interface I_AD_Column
        Parameters:
        IsMandatory - Data entry is required in this column

      • isMandatory

        public boolean isMandatory()
        Get Mandatory.
        Specified by:
        isMandatory in interface I_AD_Column
        Returns:
        Data entry is required in this column

      • setIsParent

        public void setIsParent​(boolean IsParent)
        Set Parent link column.
        Specified by:
        setIsParent in interface I_AD_Column
        Parameters:
        IsParent - This column is a link to the parent table (e.g. header from lines) - incl. Association key columns

      • isParent

        public boolean isParent()
        Get Parent link column.
        Specified by:
        isParent in interface I_AD_Column
        Returns:
        This column is a link to the parent table (e.g. header from lines) - incl. Association key columns

      • setIsSecure

        public void setIsSecure​(boolean IsSecure)
        Set Secure content.
        Specified by:
        setIsSecure in interface I_AD_Column
        Parameters:
        IsSecure - Defines whether content must be treated as secure

      • isSecure

        public boolean isSecure()
        Get Secure content.
        Specified by:
        isSecure in interface I_AD_Column
        Returns:
        Defines whether content must be treated as secure

      • setIsSelectionColumn

        public void setIsSelectionColumn​(boolean IsSelectionColumn)
        Set Selection Column.
        Specified by:
        setIsSelectionColumn in interface I_AD_Column
        Parameters:
        IsSelectionColumn - Is this column used for finding rows in windows

      • isSelectionColumn

        public boolean isSelectionColumn()
        Get Selection Column.
        Specified by:
        isSelectionColumn in interface I_AD_Column
        Returns:
        Is this column used for finding rows in windows

      • setIsSyncDatabase

        public void setIsSyncDatabase​(String IsSyncDatabase)
        Set Synchronize Database.
        Specified by:
        setIsSyncDatabase in interface I_AD_Column
        Parameters:
        IsSyncDatabase - Change database table definition when changing dictionary definition

      • getIsSyncDatabase

        public String getIsSyncDatabase()
        Get Synchronize Database.
        Specified by:
        getIsSyncDatabase in interface I_AD_Column
        Returns:
        Change database table definition when changing dictionary definition

      • setIsToolbarButton

        public void setIsToolbarButton​(String IsToolbarButton)
        Set Toolbar Button.
        Specified by:
        setIsToolbarButton in interface I_AD_Column
        Parameters:
        IsToolbarButton - Show the button on the toolbar, the window, or both

      • getIsToolbarButton

        public String getIsToolbarButton()
        Get Toolbar Button.
        Specified by:
        getIsToolbarButton in interface I_AD_Column
        Returns:
        Show the button on the toolbar, the window, or both

      • setIsTranslated

        public void setIsTranslated​(boolean IsTranslated)
        Set Translated.
        Specified by:
        setIsTranslated in interface I_AD_Column
        Parameters:
        IsTranslated - This column is translated

      • isTranslated

        public boolean isTranslated()
        Get Translated.
        Specified by:
        isTranslated in interface I_AD_Column
        Returns:
        This column is translated

      • setIsUpdateable

        public void setIsUpdateable​(boolean IsUpdateable)
        Set Updatable.
        Specified by:
        setIsUpdateable in interface I_AD_Column
        Parameters:
        IsUpdateable - Determines, if the field can be updated

      • isUpdateable

        public boolean isUpdateable()
        Get Updatable.
        Specified by:
        isUpdateable in interface I_AD_Column
        Returns:
        Determines, if the field can be updated

      • setMandatoryLogic

        public void setMandatoryLogic​(String MandatoryLogic)
        Set Mandatory Logic.
        Specified by:
        setMandatoryLogic in interface I_AD_Column
        Parameters:
        MandatoryLogic - Mandatory Logic

      • setName

        public void setName​(String Name)
        Set Name.
        Specified by:
        setName in interface I_AD_Column
        Parameters:
        Name - Alphanumeric identifier of the entity

      • getName

        public String getName()
        Get Name.
        Specified by:
        getName in interface I_AD_Column
        Returns:
        Alphanumeric identifier of the entity

      • setPA_DashboardContent_ID

        public void setPA_DashboardContent_ID​(int PA_DashboardContent_ID)
        Set Dashboard Content.
        Specified by:
        setPA_DashboardContent_ID in interface I_AD_Column
        Parameters:
        PA_DashboardContent_ID - Dashboard Content

      • getPA_DashboardContent_ID

        public int getPA_DashboardContent_ID()
        Get Dashboard Content.
        Specified by:
        getPA_DashboardContent_ID in interface I_AD_Column
        Returns:
        Dashboard Content

      • setPlaceholder

        public void setPlaceholder​(String Placeholder)
        Set Placeholder.
        Specified by:
        setPlaceholder in interface I_AD_Column
        Parameters:
        Placeholder - Placeholder

      • setReadOnlyLogic

        public void setReadOnlyLogic​(String ReadOnlyLogic)
        Set Read Only Logic.
        Specified by:
        setReadOnlyLogic in interface I_AD_Column
        Parameters:
        ReadOnlyLogic - Logic to determine if field is read only (applies only when field is read-write)

      • getReadOnlyLogic

        public String getReadOnlyLogic()
        Get Read Only Logic.
        Specified by:
        getReadOnlyLogic in interface I_AD_Column
        Returns:
        Logic to determine if field is read only (applies only when field is read-write)

      • setSeqNo

        public void setSeqNo​(int SeqNo)
        Set Sequence.
        Specified by:
        setSeqNo in interface I_AD_Column
        Parameters:
        SeqNo - Method of ordering records; lowest number comes first

      • getSeqNo

        public int getSeqNo()
        Get Sequence.
        Specified by:
        getSeqNo in interface I_AD_Column
        Returns:
        Method of ordering records; lowest number comes first

      • setSeqNoSelection

        public void setSeqNoSelection​(int SeqNoSelection)
        Set Selection Column Sequence.
        Specified by:
        setSeqNoSelection in interface I_AD_Column
        Parameters:
        SeqNoSelection - Selection Column Sequence

      • getSeqNoSelection

        public int getSeqNoSelection()
        Get Selection Column Sequence.
        Specified by:
        getSeqNoSelection in interface I_AD_Column
        Returns:
        Selection Column Sequence

      • setValueMax

        public void setValueMax​(String ValueMax)
        Set Max. Value.
        Specified by:
        setValueMax in interface I_AD_Column
        Parameters:
        ValueMax - Maximum Value for a field

      • getValueMax

        public String getValueMax()
        Get Max. Value.
        Specified by:
        getValueMax in interface I_AD_Column
        Returns:
        Maximum Value for a field

      • setValueMin

        public void setValueMin​(String ValueMin)
        Set Min. Value.
        Specified by:
        setValueMin in interface I_AD_Column
        Parameters:
        ValueMin - Minimum Value for a field

      • getValueMin

        public String getValueMin()
        Get Min. Value.
        Specified by:
        getValueMin in interface I_AD_Column
        Returns:
        Minimum Value for a field

      • setVersion

        public void setVersion​(BigDecimal Version)
        Set Version.
        Specified by:
        setVersion in interface I_AD_Column
        Parameters:
        Version - Version of the table definition

      • setVFormat

        public void setVFormat​(String VFormat)
        Set Value Format.
        Specified by:
        setVFormat in interface I_AD_Column
        Parameters:
        VFormat - Format of the value; Can contain fixed format elements, Variables: "_lLoOaAcCa09"

      • getVFormat

        public String getVFormat()
        Get Value Format.
        Specified by:
        getVFormat in interface I_AD_Column
        Returns:
        Format of the value; Can contain fixed format elements, Variables: "_lLoOaAcCa09"