Package com.smartsheet.api.models

Class Column.AddColumnToSheetBuilder

  • Enclosing class:
    Column
    public static class Column.AddColumnToSheetBuilder
extends java.lang.Object
    A convenience class to help create a column object with the appropriate fields for adding to a sheet.

    • Constructor Detail

      • AddColumnToSheetBuilder

        public AddColumnToSheetBuilder()

    • Method Detail

      • getWidth

        public java.lang.Integer getWidth()
        Gets the width for the column.
        Returns:
        the width

      • setWidth

        public Column.AddColumnToSheetBuilder setWidth​(java.lang.Integer width)
        Sets the width for the column.
        Parameters:
        width - the width
        Returns:
        the column to sheet builder

      • getPrimary

        public java.lang.Boolean getPrimary()
        Gets the primary status for the column.
        Returns:
        the boolean primary

      • setPrimary

        public Column.AddColumnToSheetBuilder setPrimary​(java.lang.Boolean primary)
        Sets the primary status for the column.
        Parameters:
        primary - the boolean primary
        Returns:
        the column to sheet builder

      • setTitle

        public Column.AddColumnToSheetBuilder setTitle​(java.lang.String title)
        Sets the title for the column.
        Parameters:
        title - the title
        Returns:
        the add the column to sheet builder

      • getTitle

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

      • getType

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

      • setOptions

        public Column.AddColumnToSheetBuilder setOptions​(java.util.List<java.lang.String> options)
        Sets the options for the column.
        Parameters:
        options - the options
        Returns:
        the adds the column to sheet builder

      • getOptions

        public java.util.List<java.lang.String> getOptions()
        Gets the option for the column.
        Returns:
        the option

      • setSymbol

        public Column.AddColumnToSheetBuilder setSymbol​(Symbol symbol)
        Sets the symbol for the column.
        Parameters:
        symbol - the symbol
        Returns:
        the adds the column to sheet builder

      • getSymbol

        public Symbol getSymbol()
        Gets the symbol for the column.
        Returns:
        the symbol

      • setSystemColumnType

        public Column.AddColumnToSheetBuilder setSystemColumnType​(SystemColumnType systemColumnType)
        Sets the system column type.
        Parameters:
        systemColumnType - the system column type
        Returns:
        the adds the column to sheet builder

      • getSystemColumnType

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

      • setAutoNumberFormat

        public Column.AddColumnToSheetBuilder setAutoNumberFormat​(AutoNumberFormat autoNumberFormat)
        Sets the format for an auto number column.
        Parameters:
        autoNumberFormat - the auto number format
        Returns:
        the adds the column to sheet builder

      • getAutoNumberFormat

        public AutoNumberFormat getAutoNumberFormat()
        Gets the format for an auto number column.
        Returns:
        the format for an auto number column

      • getIndex

        public java.lang.Integer getIndex()
        Gets the index specified for the new column.
        Returns:
        the index

      • setIndex

        public Column.AddColumnToSheetBuilder setIndex​(java.lang.Integer index)
        Sets the index for the column. Set this to any value greater than the index of the last column to add it as the last column.
        Parameters:
        index - the index
        Returns:
        the index

      • getFormat

        public Format getFormat()
        Gets the format for a column.
        Returns:
        the format for a column

      • setFormat

        public Column.AddColumnToSheetBuilder setFormat​(Format format)
        Sets the format for a column.
        Parameters:
        format - the format.
        Returns:
        the AddColumnToSheetBuilder.

      • getValidation

        public java.lang.Boolean getValidation()
        Gets the value of the validation flag

      • setValidation

        public Column.AddColumnToSheetBuilder setValidation​(java.lang.Boolean validation)
        Sets the value of the validation flag
        Returns:
        the AddColumn builder

      • build

        public Column build()
        Builds the column.
        Returns:
        the column