Class X_AD_Field

    • Field Detail

      • ENTITYTYPE_AD_Reference_ID

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

        public static final int ISALLOWCOPY_AD_Reference_ID
        IsAllowCopy AD_Reference_ID=319
        See Also:
        Constant Field Values
      • ISALWAYSUPDATEABLE_AD_Reference_ID

        public static final int ISALWAYSUPDATEABLE_AD_Reference_ID
        IsAlwaysUpdateable AD_Reference_ID=319
        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
      • ISSELECTIONCOLUMN_AD_Reference_ID

        public static final int ISSELECTIONCOLUMN_AD_Reference_ID
        IsSelectionColumn AD_Reference_ID=319
        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
      • ISUPDATEABLE_AD_Reference_ID

        public static final int ISUPDATEABLE_AD_Reference_ID
        IsUpdateable AD_Reference_ID=319
        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_ObscureAlphaNumericButLast4

        public static final String OBSCURETYPE_ObscureAlphaNumericButLast4
        Obscure AlphaNumeric but last 4 = A04
        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
    • Constructor Detail

      • X_AD_Field

        public X_AD_Field​(Properties ctx,
                          int AD_Field_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_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
      • 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_FieldStyle_ID

        public void setAD_FieldStyle_ID​(int AD_FieldStyle_ID)
        Set Field Style.
        Specified by:
        setAD_FieldStyle_ID in interface I_AD_Field
        Parameters:
        AD_FieldStyle_ID - Field CSS Style
      • getAD_FieldStyle_ID

        public int getAD_FieldStyle_ID()
        Get Field Style.
        Specified by:
        getAD_FieldStyle_ID in interface I_AD_Field
        Returns:
        Field CSS Style
      • setAD_Field_UU

        public void setAD_Field_UU​(String AD_Field_UU)
        Set AD_Field_UU.
        Specified by:
        setAD_Field_UU in interface I_AD_Field
        Parameters:
        AD_Field_UU - AD_Field_UU
      • setAD_LabelStyle_ID

        public void setAD_LabelStyle_ID​(int AD_LabelStyle_ID)
        Set Label Style.
        Specified by:
        setAD_LabelStyle_ID in interface I_AD_Field
        Parameters:
        AD_LabelStyle_ID - Label CSS Style
      • getAD_LabelStyle_ID

        public int getAD_LabelStyle_ID()
        Get Label Style.
        Specified by:
        getAD_LabelStyle_ID in interface I_AD_Field
        Returns:
        Label CSS Style
      • 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
      • 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
      • 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
      • 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_Field
        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_Field
        Returns:
        Override Dynamic Validation Rule for Lookup Window
      • setColumnSpan

        public void setColumnSpan​(int ColumnSpan)
        Set Column Span.
        Specified by:
        setColumnSpan in interface I_AD_Field
        Parameters:
        ColumnSpan - Number of column for a box of field
      • getColumnSpan

        public int getColumnSpan()
        Get Column Span.
        Specified by:
        getColumnSpan in interface I_AD_Field
        Returns:
        Number of column for a box of field
      • setColumnSQL

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

        public String getColumnSQL()
        Get Column SQL.
        Specified by:
        getColumnSQL in interface I_AD_Field
        Returns:
        Virtual Column (r/o)
      • 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
      • setIncluded_Tab_ID

        public void setIncluded_Tab_ID​(int Included_Tab_ID)
        Set Included Tab.
        Specified by:
        setIncluded_Tab_ID in interface I_AD_Field
        Parameters:
        Included_Tab_ID - Included Tab in this Tab (Master Detail)
      • getIncluded_Tab_ID

        public int getIncluded_Tab_ID()
        Get Included Tab.
        Specified by:
        getIncluded_Tab_ID in interface I_AD_Field
        Returns:
        Included Tab in this Tab (Master Detail)
      • setIsAdvancedField

        public void setIsAdvancedField​(boolean IsAdvancedField)
        Set Advanced Field.
        Specified by:
        setIsAdvancedField in interface I_AD_Field
        Parameters:
        IsAdvancedField - Advanced Field
      • isAdvancedField

        public boolean isAdvancedField()
        Get Advanced Field.
        Specified by:
        isAdvancedField in interface I_AD_Field
        Returns:
        Advanced Field
      • setIsAllowCopy

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

        public String getIsAllowCopy()
        Get Allow Copy.
        Specified by:
        getIsAllowCopy in interface I_AD_Field
        Returns:
        Determine if a column must be copied when pushing the button to copy record
      • setIsAlwaysUpdateable

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

        public String getIsAlwaysUpdateable()
        Get Always Updatable.
        Specified by:
        getIsAlwaysUpdateable in interface I_AD_Field
        Returns:
        The column is always updateable, even if the record is not active or processed
      • 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
      • setIsDefaultFocus

        public void setIsDefaultFocus​(boolean IsDefaultFocus)
        Set Default Focus.
        Specified by:
        setIsDefaultFocus in interface I_AD_Field
        Parameters:
        IsDefaultFocus - Default Focus
      • isDefaultFocus

        public boolean isDefaultFocus()
        Get Default Focus.
        Specified by:
        isDefaultFocus in interface I_AD_Field
        Returns:
        Default Focus
      • 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
      • setIsDisplayedGrid

        public void setIsDisplayedGrid​(boolean IsDisplayedGrid)
        Set Show in Grid.
        Specified by:
        setIsDisplayedGrid in interface I_AD_Field
        Parameters:
        IsDisplayedGrid - Show in Grid
      • isDisplayedGrid

        public boolean isDisplayedGrid()
        Get Show in Grid.
        Specified by:
        isDisplayedGrid in interface I_AD_Field
        Returns:
        Show in Grid
      • 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
      • setIsQuickEntry

        public void setIsQuickEntry​(boolean IsQuickEntry)
        Set Quick Entry.
        Specified by:
        setIsQuickEntry in interface I_AD_Field
        Parameters:
        IsQuickEntry - Quick Entry
      • isQuickEntry

        public boolean isQuickEntry()
        Get Quick Entry.
        Specified by:
        isQuickEntry in interface I_AD_Field
        Returns:
        Quick Entry
      • setIsQuickForm

        public void setIsQuickForm​(boolean IsQuickForm)
        Set Quick Form.
        Specified by:
        setIsQuickForm in interface I_AD_Field
        Parameters:
        IsQuickForm - Display in Quick Form
      • isQuickForm

        public boolean isQuickForm()
        Get Quick Form.
        Specified by:
        isQuickForm in interface I_AD_Field
        Returns:
        Display in Quick Form
      • 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
      • setIsSelectionColumn

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

        public String getIsSelectionColumn()
        Get Selection Column.
        Specified by:
        getIsSelectionColumn in interface I_AD_Field
        Returns:
        Is this column used for finding rows in windows
      • setIsToolbarButton

        public void setIsToolbarButton​(String IsToolbarButton)
        Set Toolbar Button.
        Specified by:
        setIsToolbarButton in interface I_AD_Field
        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_Field
        Returns:
        Show the button on the toolbar, the window, or both
      • setIsUpdateable

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

        public String getIsUpdateable()
        Get Updatable.
        Specified by:
        getIsUpdateable in interface I_AD_Field
        Returns:
        Determines, if the field can be updated
      • setMandatoryLogic

        public void setMandatoryLogic​(String MandatoryLogic)
        Set Mandatory Logic.
        Specified by:
        setMandatoryLogic in interface I_AD_Field
        Parameters:
        MandatoryLogic - Mandatory Logic
      • 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
      • setNumLines

        public void setNumLines​(int NumLines)
        Set Number of Lines.
        Specified by:
        setNumLines in interface I_AD_Field
        Parameters:
        NumLines - Number of lines for a field
      • getNumLines

        public int getNumLines()
        Get Number of Lines.
        Specified by:
        getNumLines in interface I_AD_Field
        Returns:
        Number of lines for a field
      • 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)
      • setPlaceholder

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

        public void setReadOnlyLogic​(String ReadOnlyLogic)
        Set Read Only Logic.
        Specified by:
        setReadOnlyLogic in interface I_AD_Field
        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_Field
        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_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
      • setSeqNoGrid

        public void setSeqNoGrid​(int SeqNoGrid)
        Set Grid Sequence No.
        Specified by:
        setSeqNoGrid in interface I_AD_Field
        Parameters:
        SeqNoGrid - Grid Sequence No
      • getSeqNoGrid

        public int getSeqNoGrid()
        Get Grid Sequence No.
        Specified by:
        getSeqNoGrid in interface I_AD_Field
        Returns:
        Grid Sequence No
      • 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
      • setVFormat

        public void setVFormat​(String VFormat)
        Set Value Format.
        Specified by:
        setVFormat in interface I_AD_Field
        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_Field
        Returns:
        Format of the value; Can contain fixed format elements, Variables: "_lLoOaAcCa09"
      • setXPosition

        public void setXPosition​(int XPosition)
        Set X Position.
        Specified by:
        setXPosition in interface I_AD_Field
        Parameters:
        XPosition - Absolute X (horizontal) position in 1/72 of an inch
      • getXPosition

        public int getXPosition()
        Get X Position.
        Specified by:
        getXPosition in interface I_AD_Field
        Returns:
        Absolute X (horizontal) position in 1/72 of an inch