com.smartsheet.api.models.Report 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.1

/*
 * Copyright (C) 2023 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.models;

import java.util.List;

/**
 * A report object that is a filtered view of the data from one or more Sheets.
 * @see Creating Reports Help
 */
public class Report extends AbstractSheet {

    /**
     * A report's scope can be defined as the sheet ids and workspace ids that make up the report.
     */
    private Scope scope;

    /**
     * Represents the sheets that rows in the report originated from.
     */
    private List sourceSheets;

    /**
     * Gets the scope of the report
     *
     * @return the scope
     */
    public Scope getScope() {
        return scope;
    }

    /**
     * Sets the scope of the report
     */
    public Report setScope(Scope scope) {
        this.scope = scope;
        return this;
    }

    /**
     * Gets the sheet array.
     *
     * @return the sourceSheets
     */
    public List getSourceSheets() {
        return sourceSheets;
    }

    /**
     * Sets the sheet array.
     *
     * @param sourceSheets the new index
     */
    public Report setSourceSheets(List sourceSheets) {
        this.sourceSheets = sourceSheets;
        return this;
    }
}