Package com.smartsheet.api.models

Class ReportColumn.AddReportColumnBuilder

java.lang.Object

com.smartsheet.api.models.ReportColumn.AddReportColumnBuilder

Enclosing class:

ReportColumn

public static class ReportColumn.AddReportColumnBuilder
extends java.lang.Object

A convenience class to help create a ReportColumn object with the appropriate fields for adding to a report.

Constructor Summary

Constructors

Constructor	Description
AddReportColumnBuilder()

Method Summary

Modifier and Type	Method	Description
ReportColumn	build()	Builds the ReportColumn.
AutoNumberFormat	getAutoNumberFormat()	Gets the auto number format.
Format	getFormat()	Gets the format.
java.lang.Integer	getIndex()	Gets the index.
java.util.List<java.lang.String>	getOptions()	Gets the options.
java.lang.Boolean	getPrimary()	Gets the primary flag.
boolean	getSheetNameColumn()	Gets the sheet name column flag.
Symbol	getSymbol()	Gets the symbol.
SystemColumnType	getSystemColumnType()	Gets the system column type.
java.lang.String	getTitle()	Gets the title.
ColumnType	getType()	Gets the type.
java.lang.Boolean	getValidation()	Gets the validation flag.
java.lang.Integer	getWidth()	Gets the width.
ReportColumn.AddReportColumnBuilder	setAutoNumberFormat(AutoNumberFormat autoNumberFormat)	Sets the format for an auto number column.
ReportColumn.AddReportColumnBuilder	setFormat(Format format)	Sets the format for the column.
ReportColumn.AddReportColumnBuilder	setIndex(java.lang.Integer index)	Sets the index for the column.
ReportColumn.AddReportColumnBuilder	setOptions(java.util.List<java.lang.String> options)	Sets the options for the column.
ReportColumn.AddReportColumnBuilder	setPrimary(java.lang.Boolean primary)	Sets the primary flag for the column.
ReportColumn.AddReportColumnBuilder	setSheetNameColumn(boolean sheetNameColumn)	Sets the sheet name column flag.
ReportColumn.AddReportColumnBuilder	setSymbol(Symbol symbol)	Sets the symbol for the column.
ReportColumn.AddReportColumnBuilder	setSystemColumnType(SystemColumnType systemColumnType)	Sets the system column type.
ReportColumn.AddReportColumnBuilder	setTitle(java.lang.String title)	Sets the title for the column.
ReportColumn.AddReportColumnBuilder	setType(ColumnType type)	Sets the type for the column.
ReportColumn.AddReportColumnBuilder	setValidation(java.lang.Boolean validation)	Sets the validation flag for the column.
ReportColumn.AddReportColumnBuilder	setWidth(java.lang.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

AddReportColumnBuilder

public AddReportColumnBuilder()

Method Detail

setTitle

public ReportColumn.AddReportColumnBuilder setTitle(java.lang.String title)

Sets the title for the column.

Parameters:

title - the title

Returns:

the AddReportColumnBuilder

getTitle

public java.lang.String getTitle()

Gets the title.

Returns:

the title

setIndex

public ReportColumn.AddReportColumnBuilder setIndex(java.lang.Integer index)

Sets the index for the column.

Parameters:

index - the index

Returns:

the AddReportColumnBuilder

getIndex

public java.lang.Integer getIndex()

Gets the index.

Returns:

the index

setType

public ReportColumn.AddReportColumnBuilder setType(ColumnType type)

Sets the type for the column.

Parameters:

type - the type

Returns:

the AddReportColumnBuilder

getType

public ColumnType getType()

Gets the type.

Returns:

the type

setOptions

public ReportColumn.AddReportColumnBuilder setOptions(java.util.List<java.lang.String> options)

Sets the options for the column.

Parameters:

options - the options

Returns:

the AddReportColumnBuilder

getOptions

public java.util.List<java.lang.String> getOptions()

Gets the options.

Returns:

the options

setSymbol

public ReportColumn.AddReportColumnBuilder setSymbol(Symbol symbol)

Sets the symbol for the column.

Parameters:

symbol - the symbol

Returns:

the AddReportColumnBuilder

getSymbol

public Symbol getSymbol()

Gets the symbol.

Returns:

the symbol

setSystemColumnType

public ReportColumn.AddReportColumnBuilder setSystemColumnType(SystemColumnType systemColumnType)

Sets the system column type.

Parameters:

systemColumnType - the system column type

Returns:

the AddReportColumnBuilder

getSystemColumnType

public SystemColumnType getSystemColumnType()

Gets the system column type.

Returns:

the system column type

setAutoNumberFormat

public ReportColumn.AddReportColumnBuilder setAutoNumberFormat(AutoNumberFormat autoNumberFormat)

Sets the format for an auto number column.

Parameters:

autoNumberFormat - the auto number format

Returns:

the AddReportColumnBuilder

getAutoNumberFormat

public AutoNumberFormat getAutoNumberFormat()

Gets the auto number format.

Returns:

the auto number format

setWidth

public ReportColumn.AddReportColumnBuilder setWidth(java.lang.Integer width)

Sets the width for the column.

Parameters:

width - the width

Returns:

the AddReportColumnBuilder

getWidth

public java.lang.Integer getWidth()

Gets the width.

Returns:

the width

setPrimary

public ReportColumn.AddReportColumnBuilder setPrimary(java.lang.Boolean primary)

Sets the primary flag for the column.

Parameters:

primary - the primary flag

Returns:

the AddReportColumnBuilder

getPrimary

public java.lang.Boolean getPrimary()

Gets the primary flag.

Returns:

the primary flag

setFormat

public ReportColumn.AddReportColumnBuilder setFormat(Format format)

Sets the format for the column.

Parameters:

format - the format

Returns:

the AddReportColumnBuilder

getFormat

public Format getFormat()

Gets the format.

Returns:

the format

setValidation

public ReportColumn.AddReportColumnBuilder setValidation(java.lang.Boolean validation)

Sets the validation flag for the column.

Parameters:

validation - the validation flag

Returns:

the AddReportColumnBuilder

getValidation

public java.lang.Boolean getValidation()

Gets the validation flag.

Returns:

the validation flag

setSheetNameColumn

public ReportColumn.AddReportColumnBuilder setSheetNameColumn(boolean sheetNameColumn)

Sets the sheet name column flag.

Parameters:

sheetNameColumn - the sheet name column flag

Returns:

the AddReportColumnBuilder

getSheetNameColumn

public boolean getSheetNameColumn()

Gets the sheet name column flag.

Returns:

the sheet name column flag

build

public ReportColumn build()

Builds the ReportColumn.

Returns:

the ReportColumn