com.smartsheet.api.models.Template Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation
Library for connecting to Smartsheet Services
There is a newer version: 3.2.0
package com.smartsheet.api.models;

import com.smartsheet.api.models.enums.AccessLevel;
import com.smartsheet.api.models.enums.GlobalTemplate;

import java.util.List;

/*
 * #[license]
 * Smartsheet SDK for Java
 * %%
 * Copyright (C) 2014 Smartsheet
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * %[license]
 */

/**
 * A template object that is a default layout for future sheets.
 * @see Using Templates Help
 */
public class Template extends NamedModel {
	/**
	 * Represents the description for the template.
	 */
	private String description;

	/**
	 * Represents the access level for the template.
	 */
	private AccessLevel accessLevel;

	/**
	 * URL to the small preview image for this template
	 */
	private String image;
	
	/**
	 * URL to the large preview image for this template
	 */
	private String largeImage;
	
	/**
	 * Locale of the template
	 */
	private String locale;
	
	/**
	 * Type of the template. One of "sheet" or "report"
	 */
	private String type;
	
	/**
	 * List of search tags for this template
	 */
	private List tags;
	
	/**
	 * List of categories this template belongs to
	 */
	private List categories;
	
	/**
	 * Flag indicating whether the template is blank
	 */
	private Boolean blank;
	
	/**
	 * Type of global template. One of "BLANK_SHEET", "TASK_LIST", or "PROJECT_SHEET"
	 */
	private GlobalTemplate globalTemplate;
	
	/**
	 * Gets the description of the template.
	 *
	 * @return the description
	 */
	public String getDescription() {
		return description;
	}

	/**
	 * Sets the description of the template.
	 *
	 * @param description the new description
	 */
	public Template setDescription(String description) {
		this.description = description;
		return this;
	}

	/**
	 * Gets the access level of the template.
	 *
	 * @return the access level
	 */
	public AccessLevel getAccessLevel() {
		return accessLevel;
	}

	/**
	 * Sets the access level of the template.
	 *
	 * @param accessLevel the new access level
	 */
	public Template setAccessLevel(AccessLevel accessLevel) {
		this.accessLevel = accessLevel;
		return this;
	}
	
	/**
	 * Gets the URL to the small preview image for this template.
	 * 
	 * @return the URL
	 */
	public String getImage() {
		return image;
	}
	
	/**
	 * Sets the URL to the small preview image for this template.
	 *
	 * @param image
	 */
	public Template setImage(String image) {
		this.image = image;
		return this;
	}
	
	/**
	 * Gets the URL to the large preview image for this template.
	 * 
	 * @return the URL
	 */
	public String getLargeImage() {
		return largeImage;
	}
	
	/**
	 * Sets the URL to the large preview image for this template.
	 *
	 * @param largeImage
	 */
	public Template setLargeImage(String largeImage) {
		this.largeImage = largeImage;
		return this;
	}
	
	/** 
	 * Gets the locate of the template.
	 * 
	 * @return locale
	 */
	public String getLocale() {
		return locale;
	}
	
	/**
	 * Sets the locate of the template.
	 *
	 * @param locale
	 */
	public Template setLocale(String locale) {
		this.locale = locale;
		return this;
	}
	
	/**
	 * Gets the type of the template. One of "sheet" or "report"
	 * 
	 * @return type
	 */
	public String getType() {
		return type;
	}
	
	/**
	 * Sets the type of the template. One of "sheet" or "report"
	 *
	 * @param type
	 */
	public Template setType(String type) {
		this.type = type;
		return this;
	}
	
	/**
	 * Gets the list of search tags for this template.
	 * 
	 * @return array of search tags
	 */
	public List getTags() {
		return tags;
	}
	
	/**
	 * Sets the array of search tags for this template.
	 *
	 * @param tags
	 */
	public Template setTags(List tags) {
		this.tags = tags;
		return this;
	}
	
	/**
	 * Gets the list of categories this template belongs to
	 * 
	 * @return array of categories
	 */
	public List getCategories() {
		return categories;
	}
	
	/**
	 * Sets the array of categories this template belongs to
	 *
	 * @param categories
	 */
	public Template setCategories(List categories) {
		this.categories = categories;
		return this;
	}
	
	/**
	 * Returns true if this template is blank
	 * 
	 * @return flag indicating whether template is blank
	 */
	public Boolean isBlank() {
		return blank;
	}
	
	/**
	 * Sets the flag indicating whether this template is blank.
	 *
	 * @param blank
	 */
	public Template setBlank(Boolean blank) {
		this.blank = blank;
		return this;
	}
	
	/**
	 * Gets the type of global template
	 * 
	 * @return template type
	 */
	public GlobalTemplate getGlobalTemplate() {
		return globalTemplate;
	}
	
	/**
	 * Sets the type of global template
	 *
	 * @param globalTemplate
	 */
	public Template setGlobalTemplate(GlobalTemplate globalTemplate) {
		this.globalTemplate = globalTemplate;
		return this;
	}
}