com.smartsheet.api.models

Class Column

java.lang.Object

com.smartsheet.api.models.IdentifiableModel<Long>

com.smartsheet.api.models.Column

Direct Known Subclasses:

ReportColumn

public class Column
extends IdentifiableModel<Long>

Represents the Column object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Column.AddColumnToSheetBuilder A convenience class to help create a column object with the appropriate fields for adding to a sheet.
static class	Column.UpdateColumnBuilder The Class UpdateColumnBuilder.

Constructor Summary

Constructors

Constructor and Description
Column()

Method Summary

Modifier and Type	Method and Description
AutoNumberFormat	getAutoNumberFormat() Gets the format for the auto generated numbers.
List<Contact>	getContactOptions() Gets a list of contact options
Filter	getFilter() Gets the filter
Format	getFormat()
Boolean	getHidden() Gets the hidden flag.
Integer	getIndex() Gets the position of the column.
List<String>	getOptions() Gets the list of options for the column.
Boolean	getPrimary() Gets the primary flag for the column.
Symbol	getSymbol() Gets the symbol for the column.
SystemColumnType	getSystemColumnType() Gets the system column type.
List<ColumnTag>	getTags() Gets the tags that indicate a special type of column.
String	getTitle() Gets the title for the column.
ColumnType	getType() Gets the column type.
Boolean	getValidation() Gets the value of the validation flag
Integer	getWidth() Gets the width
Boolean	isLocked() Gets the locked flag
Boolean	isLockedForUser() Gets the locked for user flag
Column	setAutoNumberFormat(AutoNumberFormat autoNumberFormat) Sets the format for the auto generated numbers.
Column	setContactOptions(List<Contact> contactOptions) Sets the list of contact options
Column	setFilter(Filter filter) Sets the filter
Column	setFormat(Format format)
Column	setHidden(Boolean hidden) Sets the hidden flag.
Column	setIndex(Integer index) Sets the position of the column.
Column	setLocked(Boolean locked) Sets the locked flag
Column	setLockedForUser(Boolean lockedForUser) Sets the locked for user flag
Column	setOptions(List<String> options) Sets the list of options for the column.
Column	setPrimary(Boolean primary) Sets the primary flag for the column.
Column	setSymbol(Symbol symbol) Sets the symbol for the column.
Column	setSystemColumnType(SystemColumnType systemColumnType) Sets the system column type.
Column	setTags(List<ColumnTag> tags) Sets the tags to indicate a special type of column.
Column	setTitle(String title) Sets the title for the column.
Column	setType(ColumnType type) Sets the column type.
Column	setValidation(Boolean validation) Sets the value of the validation flag
Column	setWidth(Integer width) Sets the width

Methods inherited from class com.smartsheet.api.models.IdentifiableModel

equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

Column

public Column()

Method Detail

getIndex

public Integer getIndex()

Gets the position of the column.

Returns:

the index

setIndex

public Column setIndex(Integer index)

Sets the position of the column.

Parameters:

index - the new index

getTitle

public String getTitle()

Gets the title for the column.

Returns:

the title

setTitle

public Column setTitle(String title)

Sets the title for the column.

Parameters:

title - the new title

getPrimary

public Boolean getPrimary()

Gets the primary flag for the column.

Returns:

the primary flag

setPrimary

public Column setPrimary(Boolean primary)

Sets the primary flag for the column.

Parameters:

primary - the new primary flag

getType

public ColumnType getType()

Gets the column type.

Returns:

the type

setType

public Column setType(ColumnType type)

Sets the column type.

Parameters:

type - the new type

getOptions

public List<String> getOptions()

Gets the list of options for the column.

Returns:

the options

setOptions

public Column setOptions(List<String> options)

Sets the list of options for the column.

Parameters:

options - the new options

getHidden

public Boolean getHidden()

Gets the hidden flag.

Returns:

the hidden flag

setHidden

public Column setHidden(Boolean hidden)

Sets the hidden flag.

Parameters:

hidden - the new hidden flag

getSymbol

public Symbol getSymbol()

Gets the symbol for the column.

Returns:

the symbol

setSymbol

public Column setSymbol(Symbol symbol)

Sets the symbol for the column.

Parameters:

symbol - the new symbol

getSystemColumnType

public SystemColumnType getSystemColumnType()

Gets the system column type.

Returns:

the system column type

setSystemColumnType

public Column setSystemColumnType(SystemColumnType systemColumnType)

Sets the system column type.

Parameters:

systemColumnType - the new system column type

getAutoNumberFormat

public AutoNumberFormat getAutoNumberFormat()

Gets the format for the auto generated numbers.

Returns:

the auto number format

setAutoNumberFormat

public Column setAutoNumberFormat(AutoNumberFormat autoNumberFormat)

Sets the format for the auto generated numbers.

Parameters:

autoNumberFormat - the new auto number format

getContactOptions

public List<Contact> getContactOptions()

Gets a list of contact options

Returns:

list of contact options

setContactOptions

public Column setContactOptions(List<Contact> contactOptions)

Sets the list of contact options

Parameters:

contactOptions - the new list of contact options

Returns:

Column

getTags

public List<ColumnTag> getTags()

Gets the tags that indicate a special type of column.

Returns:

the tags

setTags

public Column setTags(List<ColumnTag> tags)

Sets the tags to indicate a special type of column.

Parameters:

tags - the new tags

isLocked

public Boolean isLocked()

Gets the locked flag

Returns:

the locked flag

setLocked

public Column setLocked(Boolean locked)

Sets the locked flag

Parameters:

locked - the locked flag

isLockedForUser

public Boolean isLockedForUser()

Gets the locked for user flag

Returns:

the locked for user flag

setLockedForUser

public Column setLockedForUser(Boolean lockedForUser)

Sets the locked for user flag

Parameters:

lockedForUser - the locked for user flag

getWidth

public Integer getWidth()

Gets the width

Returns:

the width

setWidth

public Column setWidth(Integer width)

Sets the width

Parameters:

width - the width

getFormat

public Format getFormat()

Returns:

the Format

setFormat

public Column setFormat(Format format)

Parameters:

format - the Format to set

getFilter

public Filter getFilter()

Gets the filter

Returns:

the filter

setFilter

public Column setFilter(Filter filter)

Sets the filter

Parameters:

filter - the filter

getValidation

public Boolean getValidation()

Gets the value of the validation flag

Returns:

the validation flag

setValidation

public Column setValidation(Boolean validation)

Sets the value of the validation flag

Parameters:

validation -

Returns:

the Column