Package sk.ipesoft.d2000.d2japi

Interface D2StructureDefinitionInfo

  • All Superinterfaces:
    D2ObjectInfo, java.io.Serializable

    public interface D2StructureDefinitionInfo
extends D2ObjectInfo
    Technical description of structure definition object.

    • Method Detail

      • getColCount

        @Deprecated
int getColCount​()
        Deprecated. As of R39, replaced by getStructureColumnCount()
        Get number of columns in strucure.
        Returns:
        number of columns

      • getStructureColumnCount

        int getStructureColumnCount​()
        Get number of columns in strucure.
        Returns:
        number of columns

      • getColumnDescription

        java.lang.String getColumnDescription​(int columnIndex)
        Get human-readable title of column at the indexed position. Title is to be displayed in user interface. Note: throws ArrayIndexOutOfBoundsException for invalid index.
        Parameters:
        columnIndex - Zero based index of the column
        Returns:
        human-readable title of the column

      • getColumnIndex

        java.lang.Integer getColumnIndex​(java.lang.String columnName)
        Get index of column identified by its name or null for unknown column.
        Parameters:
        columnName - name of the column
        Returns:
        index of the column or null

      • getColumnName

        java.lang.String getColumnName​(int columnIndex)
        Get technical name of column (identifier) at the indexed position. Note: throws ArrayIndexOutOfBoundsException for invalid index.
        Parameters:
        columnIndex - zero-based index of the column
        Returns:
        name of the column

      • getColumnStateTextHobj

        int getColumnStateTextHobj​(int columnIndex)
        Get HOBJ of StateTextDefinition object that should be used for displaying values from indexed column or zero if not used. In case that transformation palette and state text are used, state text takes precedence.
        Parameters:
        columnIndex - columnIndex zero based index of the column
        Returns:
        HOBJ of StateTextDefinition associated with the column values

      • getColumnStatusTextHOBJ

        @Deprecated
int getColumnStatusTextHOBJ​(int columnIndex)
        Deprecated. As of R39, replaced by D2ObjectInfo.getStateTextHobj()
        Get HOBJ of StateTextDefinition object that should be used for displaying values from indexed column or zero if not used. In case that transformation palette and state text are used, state text takes precedence.
        Parameters:
        columnIndex - columnIndex zero based index of the column
        Returns:
        HOBJ of StateTextDefinition associated with the column values

      • getColumnTransPalIdx

        @Deprecated
int getColumnTransPalIdx​(int columnIndex)
        Deprecated. As of R39, replaced by getColumnTransformationPaletteIndex(int)
        Get one-based index of transformation palette used for displaying values from indexed column or zero if not used. In case that transformation palette and state text are used, state text takes precedence.
        Parameters:
        columnIndex - zero based index of the column
        Returns:
        one-based index of associated transformation palette

      • getColumnTransformationPaletteIndex

        int getColumnTransformationPaletteIndex​(int columnIndex)
        Get one-based index of transformation palette used for displaying values from indexed column or zero if not used. In case that transformation palette and state text are used, state text takes precedence.
        Parameters:
        columnIndex - zero based index of the column
        Returns:
        one-based index of associated transformation palette

      • getColumnType

        sk.ipesoft.d2000.datatable.ColumnType getColumnType​(int columnIndex)
        Get type of column at the indexed position. Note: throws ArrayIndexOutOfBoundsException for invalid index.
        Parameters:
        columnIndex - zero-based index of the column
        Returns:
        type of the column

      • getColumnTypes

        java.util.Collection<sk.ipesoft.d2000.datatable.ColumnType> getColumnTypes​()
        Get ordered list of all column types.
        Returns:
        ordered list of all column types

      • getColumnUseLimits

        @Deprecated
boolean getColumnUseLimits​(int columnIndex)
        Deprecated. As of R39, replaced by isLimitsUsed(int)
        Get true if column has limit values specified, false otherwise.
        Parameters:
        columnIndex - zero based index of the column
        Returns:
        true if column has limit values specified, false otherwise

      • getColumnUsePrAlarm

        @Deprecated
boolean getColumnUsePrAlarm​(int columnIndex)
        Deprecated. As of R39, replaced by isProcessAlarmUsed(int)
        Get true if column has usage of process alarm turned on, false otherwise.
        Parameters:
        columnIndex - columnIndex zero based index of the column
        Returns:
        true if column has usage of process alarm turned on, false otherwise

      • getColumnUseStartVal

        @Deprecated
boolean getColumnUseStartVal​(int columnIndex)
        Deprecated. As of R39, replaced by isStartValueUsed(int)
        Get true if column has a default value for new row specified, false otherwise. Default value is used only in global structured value objects.
        Parameters:
        columnIndex - zero based index of the column
        Returns:
        true if column has a default value for new row specified, false otherwise

      • isLimitsUsed

        boolean isLimitsUsed​(int columnIndex)
        Get true if column has limit values specified, false otherwise.
        Parameters:
        columnIndex - zero based index of the column
        Returns:
        true if column has limit values specified, false otherwise

      • isProcessAlarmUsed

        boolean isProcessAlarmUsed​(int columnIndex)
        Get true if column has usage of process alarm turned on, false otherwise.
        Parameters:
        columnIndex - columnIndex zero based index of the column
        Returns:
        true if column has usage of process alarm turned on, false otherwise

      • isStartValueUsed

        boolean isStartValueUsed​(int columnIndex)
        Get true if column has a default value for new row specified, false otherwise. Default value is used only in global structured value objects.
        Parameters:
        columnIndex - zero based index of the column
        Returns:
        true if column has a default value for new row specified, false otherwise