Package com.smartsheet.api.models
Class Column
- java.lang.Object
-
- com.smartsheet.api.models.IdentifiableModel<java.lang.Long>
-
- com.smartsheet.api.models.Column
-
- Direct Known Subclasses:
ReportColumn
public class Column extends IdentifiableModel<java.lang.Long>
Represents the Column object.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classColumn.AddColumnToSheetBuilderA convenience class to help create a column object with the appropriate fields for adding to a sheet.static classColumn.UpdateColumnBuilderThe Class UpdateColumnBuilder.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AutoNumberFormatgetAutoNumberFormat()Gets the format for the auto generated numbers.java.util.List<Contact>getContactOptions()Gets a list of contact optionsjava.lang.StringgetDescription()Gets the column descriptionFormatgetFormat()java.lang.StringgetFormula()java.lang.BooleangetHidden()Gets the hidden flag.java.lang.IntegergetIndex()Gets the position of the column.java.util.List<java.lang.String>getOptions()Gets the list of options for the column.java.lang.BooleangetPrimary()Gets the primary flag for the column.SymbolgetSymbol()Gets the symbol for the column.SystemColumnTypegetSystemColumnType()Gets the system column type.java.util.List<ColumnTag>getTags()Gets the tags that indicate a special type of column.java.lang.StringgetTitle()Gets the title for the column.ColumnTypegetType()Gets the column type.java.lang.BooleangetValidation()Gets the value of the validation flagjava.lang.IntegergetVersion()Gets the column compatibility versionjava.lang.IntegergetWidth()Gets the widthjava.lang.BooleanisLocked()Gets the locked flagjava.lang.BooleanisLockedForUser()Gets the locked for user flagColumnsetAutoNumberFormat(AutoNumberFormat autoNumberFormat)Sets the format for the auto generated numbers.ColumnsetContactOptions(java.util.List<Contact> contactOptions)Sets the list of contact optionsColumnsetDescription(java.lang.String description)Sets the column descriptionColumnsetFormat(Format format)ColumnsetFormula(java.lang.String formula)ColumnsetHidden(java.lang.Boolean hidden)Sets the hidden flag.ColumnsetIndex(java.lang.Integer index)Sets the position of the column.ColumnsetLocked(java.lang.Boolean locked)Sets the locked flagColumnsetLockedForUser(java.lang.Boolean lockedForUser)Sets the locked for user flagColumnsetOptions(java.util.List<java.lang.String> options)Sets the list of options for the column.ColumnsetPrimary(java.lang.Boolean primary)Sets the primary flag for the column.ColumnsetSymbol(Symbol symbol)Sets the symbol for the column.ColumnsetSystemColumnType(SystemColumnType systemColumnType)Sets the system column type.ColumnsetTags(java.util.List<ColumnTag> tags)Sets the tags to indicate a special type of column.ColumnsetTitle(java.lang.String title)Sets the title for the column.ColumnsetType(ColumnType type)Sets the column type.ColumnsetValidation(java.lang.Boolean validation)Sets the value of the validation flagColumnsetVersion(java.lang.Integer version)Sets the column compatibility versionColumnsetWidth(java.lang.Integer width)Sets the width-
Methods inherited from class com.smartsheet.api.models.IdentifiableModel
equals, getId, hashCode, setId
-
-
-
-
Method Detail
-
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
-
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
-
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 java.util.List<Contact> getContactOptions()
Gets a list of contact options- Returns:
- list of contact options
-
setContactOptions
public Column setContactOptions(java.util.List<Contact> contactOptions)
Sets the list of contact options- Parameters:
contactOptions- the new list of contact options- Returns:
- Column
-
getDescription
public java.lang.String getDescription()
Gets the column description- Returns:
- the column description
-
setDescription
public Column setDescription(java.lang.String description)
Sets the column description
-
getFormula
public java.lang.String getFormula()
- Returns:
- the column formula
-
setFormula
public Column setFormula(java.lang.String formula)
- Parameters:
formula- the column formula
-
getHidden
public java.lang.Boolean getHidden()
Gets the hidden flag.- Returns:
- the hidden flag
-
setHidden
public Column setHidden(java.lang.Boolean hidden)
Sets the hidden flag.- Parameters:
hidden- the new hidden flag
-
getIndex
public java.lang.Integer getIndex()
Gets the position of the column.- Returns:
- the index
-
setIndex
public Column setIndex(java.lang.Integer index)
Sets the position of the column.- Parameters:
index- the new index
-
isLocked
public java.lang.Boolean isLocked()
Gets the locked flag- Returns:
- the locked flag
-
setLocked
public Column setLocked(java.lang.Boolean locked)
Sets the locked flag- Parameters:
locked- the locked flag
-
isLockedForUser
public java.lang.Boolean isLockedForUser()
Gets the locked for user flag- Returns:
- the locked for user flag
-
setLockedForUser
public Column setLockedForUser(java.lang.Boolean lockedForUser)
Sets the locked for user flag- Parameters:
lockedForUser- the locked for user flag
-
getOptions
public java.util.List<java.lang.String> getOptions()
Gets the list of options for the column.- Returns:
- the options
-
setOptions
public Column setOptions(java.util.List<java.lang.String> options)
Sets the list of options for the column.- Parameters:
options- the new options
-
getPrimary
public java.lang.Boolean getPrimary()
Gets the primary flag for the column.- Returns:
- the primary flag
-
setPrimary
public Column setPrimary(java.lang.Boolean primary)
Sets the primary flag for the column.- Parameters:
primary- the new primary 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
-
getTags
public java.util.List<ColumnTag> getTags()
Gets the tags that indicate a special type of column.- Returns:
- the tags
-
setTags
public Column setTags(java.util.List<ColumnTag> tags)
Sets the tags to indicate a special type of column.- Parameters:
tags- the new tags
-
getTitle
public java.lang.String getTitle()
Gets the title for the column.- Returns:
- the title
-
setTitle
public Column setTitle(java.lang.String title)
Sets the title for the column.- Parameters:
title- the new title
-
getValidation
public java.lang.Boolean getValidation()
Gets the value of the validation flag- Returns:
- the validation flag
-
setValidation
public Column setValidation(java.lang.Boolean validation)
Sets the value of the validation flag- Returns:
- the Column
-
getVersion
public java.lang.Integer getVersion()
Gets the column compatibility version- Returns:
- version 0 for existing types, 1 for multi-assign, greater than 1 for future types.
-
setVersion
public Column setVersion(java.lang.Integer version)
Sets the column compatibility version- Parameters:
version- 0 for existing types, 1 for multi-assign, greater than 1 for future types.- Returns:
- the Column
-
getWidth
public java.lang.Integer getWidth()
Gets the width- Returns:
- the width
-
setWidth
public Column setWidth(java.lang.Integer width)
Sets the width- Parameters:
width- the width
-
-