com.smartsheet.api.models

Class SummaryField

java.lang.Object

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

com.smartsheet.api.models.SummaryField

public class SummaryField
extends IdentifiableModel<Long>

Constructor Summary

Constructors

Constructor and Description
SummaryField()

Method Summary

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

Description copied from class: IdentifiableModel

Gets the id.

Overrides:

getId in class IdentifiableModel<Long>

Returns:

the id

setId

public IdentifiableModel<Long> setId(Long id)

Description copied from class: IdentifiableModel

Sets the id.

Overrides:

setId in class IdentifiableModel<Long>

Parameters:

id - the new id

getContactOptions

public List<Contact> getContactOptions()

Get contact options, only valid when type is CONTACT_LIST

Returns:

contactOptions

setContactOptions

public SummaryField setContactOptions(List<Contact> contactOptions)

Set contact options

Parameters:

contactOptions -

getCreatedAt

public Date getCreatedAt()

Get summary field time of creation

Returns:

createdAt

setCreatedAt

public SummaryField setCreatedAt(Date createdAt)

Set summary field time of creation

Parameters:

createdAt -

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

Parameters:

createdBy -

getDisplayValue

public String getDisplayValue()

Gets the display value of the summary field

Returns:

displayValue

setDisplayValue

public SummaryField setDisplayValue(String displayValue)

Sets the display value of the summary field

Parameters:

displayValue -

getFormat

public Format getFormat()

Gets the format descriptor

Returns:

format

setFormat

public SummaryField setFormat(Format format)

Sets the format descriptor

Parameters:

format -

getFormula

public String getFormula()

Gets the formula for the summary field

Returns:

formula

setFormula

public SummaryField setFormula(String formula)

Sets the formula for the summary field

Parameters:

formula -

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

Parameters:

hyperlink -

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

Parameters:

image -

getIndex

public Integer getIndex()

Gets the field index or position

Returns:

index

setIndex

public SummaryField setIndex(Integer index)

Sets the field index or position

Parameters:

index -

getLocked

public Boolean getLocked()

Gets flag indicating if field is locked

Returns:

locked

setLocked

public SummaryField setLocked(Boolean locked)

Sets flag indicating if field is locked

Parameters:

locked -

getLockedForUser

public Boolean getLockedForUser()

Gets flag indicating whether field is locked for the requesting user

Returns:

lockedForUser

setLockedForUser

public SummaryField setLockedForUser(Boolean lockedForUser)

Sets flag indicating whether field is locked for the requesting user

Parameters:

lockedForUser -

getModifiedAt

public Date getModifiedAt()

Gets the last modification date and time

Returns:

modifiedAt

setModifiedAt

public SummaryField setModifiedAt(Date modifiedAt)

Sets the last modification date and time

Parameters:

modifiedAt -

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

Parameters:

modifiedBy -

getObjectValue

public ObjectValue getObjectValue()

Gets the field's objectValue

Returns:

objectValue

setObjectValue

public SummaryField setObjectValue(ObjectValue objectValue)

Sets the field's objectValue

Parameters:

objectValue -

getOptions

public List<String> getOptions()

Gets PICKLIST options

Returns:

options

setOptions

public SummaryField setOptions(List<String> options)

Sets PICKLIST options

Parameters:

options -

getSymbol

public String getSymbol()

Gets applicable symbol for PICKLIST type

Returns:

symbol

setSymbol

public SummaryField setSymbol(String symbol)

Sets applicable symbo for PICKLIST type

Parameters:

symbol -

getTitle

public String getTitle()

Gets the field's title

Returns:

title

setTitle

public SummaryField setTitle(String title)

Sets the field's title

Parameters:

title -

getType

public ColumnType getType()

Sets the field's type - see Column Type

Returns:

type

setType

public SummaryField setType(ColumnType type)

Sets the field's type - see Column Type

Parameters:

type -

getValidation

public Boolean getValidation()

Gets flag indicating whether summary field values are restricted to type

Returns:

validation

setValidation

public SummaryField setValidation(Boolean validation)

Sets flag indicating whether summary field values are restricted to type

Parameters:

validation -