com.smartsheet.api.models

Class Template

java.lang.Object

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

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

com.smartsheet.api.models.Template

public class Template
extends NamedModel<Long>

A template object that is a default layout for future sheets.

See Also:

Using Templates Help

Constructor Summary

Constructors

Constructor and Description
Template()

Method Summary

Modifier and Type	Method and Description
AccessLevel	getAccessLevel() Gets the access level of the template.
List<String>	getCategories() Gets the list of categories this template belongs to
String	getDescription() Gets the description of the template.
GlobalTemplate	getGlobalTemplate() Gets the type of global template
String	getImage() Gets the URL to the small preview image for this template.
String	getLargeImage() Gets the URL to the large preview image for this template.
String	getLocale() Gets the locate of the template.
List<String>	getTags() Gets the list of search tags for this template.
String	getType() Gets the type of the template.
Boolean	isBlank() Returns true if this template is blank
Template	setAccessLevel(AccessLevel accessLevel) Sets the access level of the template.
Template	setBlank(Boolean blank) Sets the flag indicating whether this template is blank.
Template	setCategories(List<String> categories) Sets the array of categories this template belongs to
Template	setDescription(String description) Sets the description of the template.
Template	setGlobalTemplate(GlobalTemplate globalTemplate) Sets the type of global template
Template	setImage(String image) Sets the URL to the small preview image for this template.
Template	setLargeImage(String largeImage) Sets the URL to the large preview image for this template.
Template	setLocale(String locale) Sets the locate of the template.
Template	setTags(List<String> tags) Sets the array of search tags for this template.
Template	setType(String type) Sets the type of the template.

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

getName, setName

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

Template

public Template()

Method Detail

getDescription

public String getDescription()

Gets the description of the template.

Returns:

the description

setDescription

public Template setDescription(String description)

Sets the description of the template.

Parameters:

description - the new description

getAccessLevel

public AccessLevel getAccessLevel()

Gets the access level of the template.

Returns:

the access level

setAccessLevel

public Template setAccessLevel(AccessLevel accessLevel)

Sets the access level of the template.

Parameters:

accessLevel - the new access level

getImage

public String getImage()

Gets the URL to the small preview image for this template.

Returns:

the URL

setImage

public Template setImage(String image)

Sets the URL to the small preview image for this template.

Parameters:

image -

getLargeImage

public String getLargeImage()

Gets the URL to the large preview image for this template.

Returns:

the URL

setLargeImage

public Template setLargeImage(String largeImage)

Sets the URL to the large preview image for this template.

Parameters:

largeImage -

getLocale

public String getLocale()

Gets the locate of the template.

Returns:

locale

setLocale

public Template setLocale(String locale)

Sets the locate of the template.

Parameters:

locale -

getType

public String getType()

Gets the type of the template. One of "sheet" or "report"

Returns:

type

setType

public Template setType(String type)

Sets the type of the template. One of "sheet" or "report"

Parameters:

type -

getTags

public List<String> getTags()

Gets the list of search tags for this template.

Returns:

array of search tags

setTags

public Template setTags(List<String> tags)

Sets the array of search tags for this template.

Parameters:

tags -

getCategories

public List<String> getCategories()

Gets the list of categories this template belongs to

Returns:

array of categories

setCategories

public Template setCategories(List<String> categories)

Sets the array of categories this template belongs to

Parameters:

categories -

isBlank

public Boolean isBlank()

Returns true if this template is blank

Returns:

flag indicating whether template is blank

setBlank

public Template setBlank(Boolean blank)

Sets the flag indicating whether this template is blank.

Parameters:

blank -

getGlobalTemplate

public GlobalTemplate getGlobalTemplate()

Gets the type of global template

Returns:

template type

setGlobalTemplate

public Template setGlobalTemplate(GlobalTemplate globalTemplate)

Sets the type of global template

Parameters:

globalTemplate -