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

/*
 * #[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 com.smartsheet.api.models.Error;

/**
 * This is the exception to indicate errors (Error objects of Smartsheet REST API) returned from Smartsheet REST API.
 * 
 * Thread safety: Exceptions are not thread safe.
 */
public class SmartsheetRestException extends SmartsheetException {
	
	/** The Constant serialVersionUID. */
	private static final long serialVersionUID = 1L;
	/**
	 * Represents the error code.
	 * 
	 * It will be initialized in constructor and will not change afterwards.
	 */
	private final int errorCode;

	/**
	 * Constructor.
	 *
	 * @param error the Error object from Smartsheet REST API
	 */
	public SmartsheetRestException(Error error) {
		super(error.getMessage());
		errorCode = error.getErrorCode();
	}
	
	

	/**
	 * Returns the error code.
	 *
	 * @return the error code
	 */
	public int getErrorCode() {
		return this.errorCode;
	}
}