Package com.smartsheet.api.models

Class ReportColumnIdentifier

  • public class ReportColumnIdentifier
extends java.lang.Object
    Object used to match a sheet column for a report.

    Requires one of:

    • [type, title] for regular columns
    • [type, systemColumnType] for system columns
    • [type=TEXT_NUMBER, primary=true] for the primary column
    • [type=TEXT_NUMBER, sheetNameColumn=true] for the special sheet name report column

    Note: You can combine multiple CHECKBOX columns or multiple PICKLIST columns from different sheets into a single report column, even if their underlying symbols differ. However, you can't combine a CHECKBOX column with a PICKLIST column, because they're different types.

    • Constructor Detail

      • ReportColumnIdentifier

        public ReportColumnIdentifier()

    • Method Detail

      • getTitle

        public java.lang.String getTitle()
        Gets the column title.
        Returns:
        the title

      • setTitle

        public ReportColumnIdentifier setTitle​(java.lang.String title)
        Sets the column title.

        If primary is true, this can be used to customize the primary column title in the report.

        Parameters:
        title - the title

      • getType

        public ColumnType getType()
        Gets the column type.
        Returns:
        the type

      • getSystemColumnType

        public SystemColumnType getSystemColumnType()
        Gets the system column type.
        Returns:
        the system column type

      • setSystemColumnType

        public ReportColumnIdentifier setSystemColumnType​(SystemColumnType systemColumnType)
        Sets the system column type.
        Parameters:
        systemColumnType - the system column type

      • getPrimary

        public java.lang.Boolean getPrimary()
        Gets whether this identifies the primary column.
        Returns:
        true if this is the primary column, false otherwise

      • setPrimary

        public ReportColumnIdentifier setPrimary​(java.lang.Boolean primary)
        Sets whether this identifies the primary column.
        Parameters:
        primary - true if this is the primary column, false otherwise

      • getSheetNameColumn

        public java.lang.Boolean getSheetNameColumn()
        Gets whether this identifies the sheet name report column.
        Returns:
        true if this is the sheet name column, false otherwise

      • setSheetNameColumn

        public ReportColumnIdentifier setSheetNameColumn​(java.lang.Boolean sheetNameColumn)
        Sets whether this identifies the sheet name report column.
        Parameters:
        sheetNameColumn - true if this is the sheet name column, false otherwise