java.lang.Object
- com.smartsheet.api.models.IdentifiableModel<java.lang.Long>
- - com.smartsheet.api.models.SummaryField

public class SummaryField
extends IdentifiableModel<java.lang.Long>

Constructor Summary

Constructors
Constructor Description

SummaryField()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<Contact>`	`getContactOptions()`	Get contact options, only valid when type is CONTACT_LIST
`java.util.Date`	`getCreatedAt()`	Get summary field time of creation
`User`	`getCreatedBy()`	Get User object of summary field creator
`java.lang.String`	`getDisplayValue()`	Gets the display value of the summary field
`Format`	`getFormat()`	Gets the format descriptor
`java.lang.String`	`getFormula()`	Gets the formula for the summary field
`Hyperlink`	`getHyperlink()`	Gets the hyperlink associated with the field, if any
`java.lang.Long`	`getId()`	Gets the id.
`Image`	`getImage()`	Gets the image associated with the field, if any
`java.lang.Integer`	`getIndex()`	Gets the field index or position
`java.lang.Boolean`	`getLocked()`	Gets flag indicating if field is locked
`java.lang.Boolean`	`getLockedForUser()`	Gets flag indicating whether field is locked for the requesting user
`java.util.Date`	`getModifiedAt()`	Gets the last modification date and time
`User`	`getModifiedBy()`	Get the User who last modified the field
`ObjectValue`	`getObjectValue()`	Gets the field's objectValue
`java.util.List<java.lang.String>`	`getOptions()`	Gets PICKLIST options
`java.lang.String`	`getSymbol()`	Gets applicable symbol for PICKLIST type
`java.lang.String`	`getTitle()`	Gets the field's title
`ColumnType`	`getType()`	Gets the field's type - see Column Type
`java.lang.Boolean`	`getValidation()`	Gets flag indicating whether summary field values are restricted to type
`SummaryField`	`setContactOptions(java.util.List<Contact> contactOptions)`	Set contact options
`SummaryField`	`setCreatedAt(java.util.Date createdAt)`	Set summary field time of creation
`SummaryField`	`setCreatedBy(User createdBy)`	Set User object of summary field creator
`SummaryField`	`setDisplayValue(java.lang.String displayValue)`	Sets the display value of the summary field
`SummaryField`	`setFormat(Format format)`	Sets the format descriptor
`SummaryField`	`setFormula(java.lang.String formula)`	Sets the formula for the summary field
`SummaryField`	`setHyperlink(Hyperlink hyperlink)`	Sets the hyperlink associated with the field
`IdentifiableModel<java.lang.Long>`	`setId(java.lang.Long id)`	Sets the id.
`SummaryField`	`setImage(Image image)`	Sets the image associated with the field
`SummaryField`	`setIndex(java.lang.Integer index)`	Sets the field index or position
`SummaryField`	`setLocked(java.lang.Boolean locked)`	Sets flag indicating if field is locked
`SummaryField`	`setLockedForUser(java.lang.Boolean lockedForUser)`	Sets flag indicating whether field is locked for the requesting user
`SummaryField`	`setModifiedAt(java.util.Date modifiedAt)`	Sets the last modification date and time
`SummaryField`	`setModifiedBy(User modifiedBy)`	Sets the User who last modified the field
`SummaryField`	`setObjectValue(ObjectValue objectValue)`	Sets the field's objectValue
`SummaryField`	`setOptions(java.util.List<java.lang.String> options)`	Sets PICKLIST options
`SummaryField`	`setSymbol(java.lang.String symbol)`	Sets applicable symbo for PICKLIST type
`SummaryField`	`setTitle(java.lang.String title)`	Sets the field's title
`SummaryField`	`setType(ColumnType type)`	Sets the field's type - see Column Type
`SummaryField`	`setValidation(java.lang.Boolean validation)`	Sets flag indicating whether summary field values are restricted to type

Methods inherited from class com.smartsheet.api.models.IdentifiableModel
equals, hashCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SummaryField
```
public SummaryField()
```
- Method Detail
  - getId
```
public java.lang.Long getId()
```
    Description copied from class: IdentifiableModel
    
    Gets the id.
    
    Overrides:
    
    getId in class IdentifiableModel<java.lang.Long>
    
    Returns:
    
    the id
  - setId
```
public IdentifiableModel<java.lang.Long> setId(java.lang.Long id)
```
    Description copied from class: IdentifiableModel
    
    Sets the id.
    
    Overrides:
    
    setId in class IdentifiableModel<java.lang.Long>
    
    Parameters:
    
    id - the new id
  - getContactOptions
```
public java.util.List<Contact> getContactOptions()
```
    Get contact options, only valid when type is CONTACT_LIST
    
    Returns:
    
    contactOptions
  - setContactOptions
```
public SummaryField setContactOptions(java.util.List<Contact> contactOptions)
```
    Set contact options
  - getCreatedAt
```
public java.util.Date getCreatedAt()
```
    Get summary field time of creation
    
    Returns:
    
    createdAt
  - setCreatedAt
```
public SummaryField setCreatedAt(java.util.Date createdAt)
```
    Set summary field time of creation
  - getCreatedBy
```
public User getCreatedBy()
```
    Get User object of summary field creator
    
    Returns:
    
    createdBy
  - setCreatedBy
```
public SummaryField setCreatedBy(User createdBy)
```
    Set User object of summary field creator
  - getDisplayValue
```
public java.lang.String getDisplayValue()
```
    Gets the display value of the summary field
    
    Returns:
    
    displayValue
  - setDisplayValue
```
public SummaryField setDisplayValue(java.lang.String displayValue)
```
    Sets the display value of the summary field
  - getFormat
```
public Format getFormat()
```
    Gets the format descriptor
    
    Returns:
    
    format
  - setFormat
```
public SummaryField setFormat(Format format)
```
    Sets the format descriptor
  - getFormula
```
public java.lang.String getFormula()
```
    Gets the formula for the summary field
    
    Returns:
    
    formula
  - setFormula
```
public SummaryField setFormula(java.lang.String formula)
```
    Sets the formula for the summary field
  - getHyperlink
```
public Hyperlink getHyperlink()
```
    Gets the hyperlink associated with the field, if any
    
    Returns:
    
    hyperlink
  - setHyperlink
```
public SummaryField setHyperlink(Hyperlink hyperlink)
```
    Sets the hyperlink associated with the field
  - getImage
```
public Image getImage()
```
    Gets the image associated with the field, if any
    
    Returns:
    
    image
  - setImage
```
public SummaryField setImage(Image image)
```
    Sets the image associated with the field
  - getIndex
```
public java.lang.Integer getIndex()
```
    Gets the field index or position
    
    Returns:
    
    index
  - setIndex
```
public SummaryField setIndex(java.lang.Integer index)
```
    Sets the field index or position
  - getLocked
```
public java.lang.Boolean getLocked()
```
    Gets flag indicating if field is locked
    
    Returns:
    
    locked
  - setLocked
```
public SummaryField setLocked(java.lang.Boolean locked)
```
    Sets flag indicating if field is locked
  - getLockedForUser
```
public java.lang.Boolean getLockedForUser()
```
    Gets flag indicating whether field is locked for the requesting user
    
    Returns:
    
    lockedForUser
  - setLockedForUser
```
public SummaryField setLockedForUser(java.lang.Boolean lockedForUser)
```
    Sets flag indicating whether field is locked for the requesting user
  - getModifiedAt
```
public java.util.Date getModifiedAt()
```
    Gets the last modification date and time
    
    Returns:
    
    modifiedAt
  - setModifiedAt
```
public SummaryField setModifiedAt(java.util.Date modifiedAt)
```
    Sets the last modification date and time
  - getModifiedBy
```
public User getModifiedBy()
```
    Get the User who last modified the field
    
    Returns:
    
    modifiedBy
  - setModifiedBy
```
public SummaryField setModifiedBy(User modifiedBy)
```
    Sets the User who last modified the field
  - getObjectValue
```
public ObjectValue getObjectValue()
```
    Gets the field's objectValue
    
    Returns:
    
    objectValue
  - setObjectValue
```
public SummaryField setObjectValue(ObjectValue objectValue)
```
    Sets the field's objectValue
  - getOptions
```
public java.util.List<java.lang.String> getOptions()
```
    Gets PICKLIST options
    
    Returns:
    
    options
  - setOptions
```
public SummaryField setOptions(java.util.List<java.lang.String> options)
```
    Sets PICKLIST options
  - getSymbol
```
public java.lang.String getSymbol()
```
    Gets applicable symbol for PICKLIST type
    
    Returns:
    
    symbol
  - setSymbol
```
public SummaryField setSymbol(java.lang.String symbol)
```
    Sets applicable symbo for PICKLIST type
  - getTitle
```
public java.lang.String getTitle()
```
    Gets the field's title
    
    Returns:
    
    title
  - setTitle
```
public SummaryField setTitle(java.lang.String title)
```
    Sets the field's title
  - getType
```
public ColumnType getType()
```
    Gets the field's type - see Column Type
    
    Returns:
    
    type
  - setType
```
public SummaryField setType(ColumnType type)
```
    Sets the field's type - see Column Type
  - getValidation
```
public java.lang.Boolean getValidation()
```
    Gets flag indicating whether summary field values are restricted to type
    
    Returns:
    
    validation
  - setValidation
```
public SummaryField setValidation(java.lang.Boolean validation)
```
    Sets flag indicating whether summary field values are restricted to type

Class SummaryField

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

SummaryField

Method Detail

getId

setId

getContactOptions

setContactOptions

getCreatedAt

setCreatedAt

getCreatedBy

setCreatedBy

getDisplayValue

setDisplayValue

getFormat

setFormat

getFormula

setFormula

getHyperlink

setHyperlink

getImage

setImage

getIndex

setIndex

getLocked

setLocked

getLockedForUser

setLockedForUser

getModifiedAt

setModifiedAt

getModifiedBy

setModifiedBy

getObjectValue

setObjectValue

getOptions

setOptions

getSymbol

setSymbol

getTitle

setTitle

getType

setType

getValidation

setValidation