com.smartsheet.api.models

Class Column.AddColumnToSheetBuilder

java.lang.Object

com.smartsheet.api.models.Column.AddColumnToSheetBuilder

Enclosing class:

Column

public static class Column.AddColumnToSheetBuilder
extends Object

A convenience class to help create a column object with the appropriate fields for adding to a sheet.

Constructor Summary

Constructors

Constructor and Description
AddColumnToSheetBuilder()

Method Summary

Modifier and Type	Method and Description
Column	build() Builds the column.
AutoNumberFormat	getAutoNumberFormat() Gets the format for an auto number column.
Format	getFormat() Gets the format for a column.
Integer	getIndex() Gets the index specified for the new column.
List<String>	getOptions() Gets the option for the column.
Boolean	getPrimary() Gets the primary status for the column.
Symbol	getSymbol() Gets the symbol for the column.
SystemColumnType	getSystemColumnType() Gets the system column type.
String	getTitle() Gets the title.
ColumnType	getType() Gets the type for the column.
Boolean	getValidation() Gets the value of the validation flag
Integer	getWidth() Gets the width for the column.
Column.AddColumnToSheetBuilder	setAutoNumberFormat(AutoNumberFormat autoNumberFormat) Sets the format for an auto number column.
Column.AddColumnToSheetBuilder	setFormat(Format format)
Column.AddColumnToSheetBuilder	setIndex(Integer index) Sets the index for the column.
Column.AddColumnToSheetBuilder	setOptions(List<String> options) Sets the options for the column.
Column.AddColumnToSheetBuilder	setPrimary(Boolean primary) Sets the primary status for the column.
Column.AddColumnToSheetBuilder	setSymbol(Symbol symbol) Sets the symbol for the column.
Column.AddColumnToSheetBuilder	setSystemColumnType(SystemColumnType systemColumnType) Sets the system column type.
Column.AddColumnToSheetBuilder	setTitle(String title) Sets the title for the column.
Column.AddColumnToSheetBuilder	setType(ColumnType type) Sets the type for the column.
Column.AddColumnToSheetBuilder	setValidation(Boolean validation) Sets the value of the validation flag
Column.AddColumnToSheetBuilder	setWidth(Integer width) Sets the width for the column.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddColumnToSheetBuilder

public AddColumnToSheetBuilder()

Method Detail

getWidth

public Integer getWidth()

Gets the width for the column.

Returns:

the width

setWidth

public Column.AddColumnToSheetBuilder setWidth(Integer width)

Sets the width for the column.

Parameters:

width - the width

Returns:

the column to sheet builder

getPrimary

public Boolean getPrimary()

Gets the primary status for the column.

Returns:

the boolean primary

setPrimary

public Column.AddColumnToSheetBuilder setPrimary(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(String title)

Sets the title for the column.

Parameters:

title - the title

Returns:

the add the column to sheet builder

getTitle

public String getTitle()

Gets the title.

Returns:

the title

setType

public Column.AddColumnToSheetBuilder setType(ColumnType type)

Sets the type for the column.

Parameters:

type - the type

Returns:

the adds the column to sheet builder

getType

public ColumnType getType()

Gets the type for the column.

Returns:

the type

setOptions

public Column.AddColumnToSheetBuilder setOptions(List<String> options)

Sets the options for the column.

Parameters:

options - the options

Returns:

the adds the column to sheet builder

getOptions

public List<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 Integer getIndex()

Gets the index specified for the new column.

Returns:

the index

setIndex

public Column.AddColumnToSheetBuilder setIndex(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)

Parameters:

format - the format. Sets the format for a column.

Returns:

the AddColumnToSheetBuilder.

getValidation

public Boolean getValidation()

Gets the value of the validation flag

Returns:

setValidation

public Column.AddColumnToSheetBuilder setValidation(Boolean validation)

Sets the value of the validation flag

Parameters:

validation -

Returns:

the AddColumn builder

build

public Column build()

Builds the column.

Returns:

the column