com.smartsheet.api.SheetCommentResources Maven / Gradle / Ivy

Go to download

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.3

/*
 * Copyright (C) 2024 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.
 */

package com.smartsheet.api;

import com.smartsheet.api.models.Comment;

/**
 * This interface provides methods to access Sheet Comment resources.
 *
 * Thread Safety: Implementation of this interface must be thread safe.
 */
public interface SheetCommentResources {
    /**
     * Get a comment.
     *
     * It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/comments/{commentId}
     *
     * @param sheetId   the ID of the sheet
     * @param commentId the ID of the comment
     * @return the comment (note that if there is no such resource, this method will throw ResourceNotFoundException
     * rather than returning null).
     * @throws SmartsheetException if there is any other error during the operation
     */
    Comment getComment(long sheetId, long commentId) throws SmartsheetException;

    /**
     * Delete a comment.
     *
     * It mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/comments/{commentId}
     *
     * @param sheetId   the ID of the sheet
     * @param commentId the ID of the comment
     * @throws SmartsheetException if there is any other error during the operation
     */
    void deleteComment(long sheetId, long commentId) throws SmartsheetException;

    /**
     * Creates an object of CommentAttachmentResources.
     *
     * @return the created attachment
     * @throws SmartsheetException if there is any other error during the operation
     */
    com.smartsheet.api.CommentAttachmentResources attachmentResources() throws SmartsheetException;
}