Package com.smartsheet.api.models
Class Template
- java.lang.Object
-
- com.smartsheet.api.models.IdentifiableModel<T>
-
- com.smartsheet.api.models.NamedModel<java.lang.Long>
-
- com.smartsheet.api.models.Template
-
public class Template extends NamedModel<java.lang.Long>
A template object that is a default layout for future sheets.- See Also:
- Using Templates Help
-
-
Constructor Summary
Constructors Constructor Description Template()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccessLevel
getAccessLevel()
Gets the access level of the template.java.util.List<java.lang.String>
getCategories()
Gets the list of categories this template belongs tojava.lang.String
getDescription()
Gets the description of the template.GlobalTemplate
getGlobalTemplate()
Gets the type of global templatejava.lang.String
getImage()
Gets the URL to the small preview image for this template.java.lang.String
getLargeImage()
Gets the URL to the large preview image for this template.java.lang.String
getLocale()
Gets the locate of the template.java.util.List<java.lang.String>
getTags()
Gets the list of search tags for this template.java.lang.String
getType()
Gets the type of the template.java.lang.Boolean
isBlank()
Returns true if this template is blankTemplate
setAccessLevel(AccessLevel accessLevel)
Sets the access level of the template.Template
setBlank(java.lang.Boolean blank)
Sets the flag indicating whether this template is blank.Template
setCategories(java.util.List<java.lang.String> categories)
Sets the array of categories this template belongs toTemplate
setDescription(java.lang.String description)
Sets the description of the template.Template
setGlobalTemplate(GlobalTemplate globalTemplate)
Sets the type of global templateTemplate
setImage(java.lang.String image)
Sets the URL to the small preview image for this template.Template
setLargeImage(java.lang.String largeImage)
Sets the URL to the large preview image for this template.Template
setLocale(java.lang.String locale)
Sets the locate of the template.Template
setTags(java.util.List<java.lang.String> tags)
Sets the array of search tags for this template.Template
setType(java.lang.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
-
-
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Gets the description of the template.- Returns:
- the description
-
setDescription
public Template setDescription(java.lang.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 java.lang.String getImage()
Gets the URL to the small preview image for this template.- Returns:
- the URL
-
setImage
public Template setImage(java.lang.String image)
Sets the URL to the small preview image for this template.
-
getLargeImage
public java.lang.String getLargeImage()
Gets the URL to the large preview image for this template.- Returns:
- the URL
-
setLargeImage
public Template setLargeImage(java.lang.String largeImage)
Sets the URL to the large preview image for this template.
-
getLocale
public java.lang.String getLocale()
Gets the locate of the template.- Returns:
- locale
-
setLocale
public Template setLocale(java.lang.String locale)
Sets the locate of the template.
-
getType
public java.lang.String getType()
Gets the type of the template. One of "sheet" or "report"- Returns:
- type
-
setType
public Template setType(java.lang.String type)
Sets the type of the template. One of "sheet" or "report"
-
getTags
public java.util.List<java.lang.String> getTags()
Gets the list of search tags for this template.
-
setTags
public Template setTags(java.util.List<java.lang.String> tags)
Sets the array of search tags for this template.
-
getCategories
public java.util.List<java.lang.String> getCategories()
Gets the list of categories this template belongs to- Returns:
- array of categories
-
setCategories
public Template setCategories(java.util.List<java.lang.String> categories)
Sets the array of categories this template belongs to
-
isBlank
public java.lang.Boolean isBlank()
Returns true if this template is blank- Returns:
- flag indicating whether template is blank
-
setBlank
public Template setBlank(java.lang.Boolean blank)
Sets the flag indicating whether this template is 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
-
-