com.smartsheet.api.models.Sheet 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;

/*
 * #[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]
 */

import java.util.List;

/**
 * Represents the Sheet object.
 */
public class Sheet extends AbstractSheet {

	/**
	 * A convenience class to make a {@link Sheet} object with the necessary fields to create the sheet by posting it 
	 * to smartsheet.
	 */
	public static class CreateSheetBuilder {
		private List columns;
		private String name;

		/**
		 * Sets the columns for the sheet being created.
		 *
		 * @param columns The columns to create with this sheet.
		 * @return the creates the builder
		 */
		public CreateSheetBuilder setColumns(List columns) {
			this.columns = columns;
			return this;
		}

		/**
		 * Sets the name for the sheet being created.
		 *
		 * @param name The name for the sheet being created.
		 * @return the creates the builder
		 */
		public CreateSheetBuilder setName(String name) {
			this.name = name;
			return this;
		}

		/**
		 * Returns the list of columns.
		 *
		 * @return the columns
		 */
		public List getColumns() {
			return columns;
		}

		/**
		 * Returns the name for the sheet.
		 *
		 * @return the name
		 */
		public String getName() {
			return name;
		}

		/**
		 * Creates a sheet by using the values from setters in this builder.
		 *
		 * @return the sheet
		 */
		public Sheet build() {
			Sheet sheet = new Sheet();

			if (columns == null || name == null) {
				throw new InstantiationError();
			}

			sheet.setColumns(columns);
			sheet.setName(name);
			return sheet;
		}
	}
	
	
	/**
	 * A class to simplify the creation of a sheet from another sheet or another template.
	 * @author brett
	 *
	 */
	public static class CreateFromTemplateOrSheetBuilder {
		private String name;
		private Long fromId;

		/**
		 * Sets the name for the sheet being created.
		 *
		 * @param name The name for the sheet being created.
		 * @return the creates the from template or sheet builder
		 */
		public CreateFromTemplateOrSheetBuilder setName(String name) {
			this.name = name;
			return this;
		}

		/**
		 * Returns the name for the sheet.
		 *
		 * @return the name
		 */
		public String getName() {
			return name;
		}
		
		/**
		 * Set the from Id.
		 *
		 * @param id the id
		 * @return the creates the from template or sheet builder
		 */
		public CreateFromTemplateOrSheetBuilder setFromId(Long id) {
			this.fromId = id;
			return this;
		}

		/**
		 * Gets the from id.
		 *
		 * @return the from id
		 */
		public Long getFromId() {
			return fromId;
		}

		/**
		 * Creates a sheet by using the values from setters in this builder.
		 *
		 * @return the sheet
		 */
		public Sheet build() {
			Sheet sheet = new Sheet();

			if (fromId == null || name == null) {
				throw new InstantiationError();
			}

			sheet.setFromId(fromId);
			sheet.setName(name);
			return sheet;
		}
	}

	
	/**
	 * The Class UpdateSheetBuilder.
	 */
	public static class UpdateSheetBuilder {
		private String sheetName;
		private Long id;
		private SheetUserSettings userSettings;

		/**
		 * Get the user settings
		 * @return the user setting
		 */
		public SheetUserSettings getUserSettings() {
			return userSettings;
		}

		/**
		 * Set the user settings
		 * @param userSettings the sheet user settings
		 * @return the updateSheetBuilder object
		 */
		public UpdateSheetBuilder setUserSettings(SheetUserSettings userSettings) {
			this.userSettings = userSettings;
			return this;
		}

		/**
		 * Get the id of the sheet
		 * @return the id
		 */
		public Long getSheetId() {
			return id;
		}

		/**
		 * Set the sheet id
		 * @param sheetId the sheet id
		 * @return the updateSheetBuilder object
		 */
		public UpdateSheetBuilder setSheetId(Long sheetId) {
			this.id = sheetId;
			return this;
		}

		/**
		 * Name.
		 *
		 * @param name the name
		 * @return the update sheet builder
		 */
		public UpdateSheetBuilder setName(String name) {
			this.sheetName = name;
			return this;
		}

		/**
		 * Gets the sheet name.
		 *
		 * @return the sheet name
		 */
		public String getName() {
			return sheetName;
		}


		/**
		 * Builds the.
		 *
		 * @return the sheet
		 */
		public Sheet build() {
			if(sheetName == null){
				throw new InstantiationError();
			}
			
			Sheet sheet = new Sheet();
			sheet.setName(sheetName);
			sheet.setId(id);
			sheet.setUserSettings(userSettings);
			return sheet;
		}
	}
}