com.smartsheet.api.models

Class AutoNumberFormat

java.lang.Object

com.smartsheet.api.models.AutoNumberFormat

public class AutoNumberFormat
extends Object

Represents the AutoNumberFormat object. It describes how the the System Column type of "AUTO_NUMBER" is auto-generated

See Also:

Auto Number Format API Documentation, Auto Number Format Help

Constructor Summary

Constructors

Constructor and Description
AutoNumberFormat()

Method Summary

Modifier and Type	Method and Description
String	getFill() Gets the fill.
String	getPrefix() Gets the prefix.
Long	getStartingNumber() Gets the starting number.
String	getSuffix() Gets the suffix.
AutoNumberFormat	setFill(String fill) Sets the fill.
AutoNumberFormat	setPrefix(String prefix) Sets the prefix.
AutoNumberFormat	setStartingNumber(Long startingNumber) Sets the starting number for the auto-id.
AutoNumberFormat	setSuffix(String suffix) Sets the suffix.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoNumberFormat

public AutoNumberFormat()

Method Detail

getPrefix

public String getPrefix()

Gets the prefix.

Returns:

the prefix

setPrefix

public AutoNumberFormat setPrefix(String prefix)

Sets the prefix. The prefix. Can include the date tokens {YY}, {YYYY}, {MM}, {DD}

Parameters:

prefix - the new prefix

getSuffix

public String getSuffix()

Gets the suffix.

Returns:

the suffix

setSuffix

public AutoNumberFormat setSuffix(String suffix)

Sets the suffix.

Parameters:

suffix - the new suffix

getFill

public String getFill()

Gets the fill.

Returns:

the fill

setFill

public AutoNumberFormat setFill(String fill)

Sets the fill. Must be 0 - 10 "0" characters. Indicates zero-padding

Parameters:

fill - the new fill

getStartingNumber

public Long getStartingNumber()

Gets the starting number.

Returns:

the starting number

setStartingNumber

public AutoNumberFormat setStartingNumber(Long startingNumber)

Sets the starting number for the auto-id.

Parameters:

startingNumber - the new starting number