smartsheet / smartsheet-java-sdk / #55

Committed 02 Oct 2024 07:40PM UTC coverage: 60.548% (+0.7%) from 59.836%

Build # #55

Build Type

push

github

Committed by

web-flow

Commit Message

Release prep for 3.2.1 (#103)

Run Details

4156 of 6864 relevant lines covered (60.55%)

0.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/main/java/com/smartsheet/api/models/ReportPublish.java

/*
 * 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.models;

/**
 * The ReportPublish object. Retruned by endpoints such as the
 *
 * @see <a href="https://smartsheet.redoc.ly/tag/sheets#operation/get-sheetPublish">get sheet publish status</a>
 */
public class ReportPublish {

    /**
     * Represents the current publish status of the report.
     */
    private boolean readOnlyFullEnabled;

    /**
     * Indicates who can see the published report
     * If "ALL", report is available to anyone who has the link.
     * If "ORG", report is available only to members of the report owner's organization.
     */
    private String readOnlyFullAccessibleBy;

    /**
     * String containing the URL of the published report.
     */
    private String readOnlyFullUrl;

    /**
     * Flag to show or hide the left nav toolbar for the read only report.
     */
    private Boolean readOnlyFullShowToolbar;

    /**
     * Default view for published report. (GRID, CARDS, CALENDAR)
     */
    private String readOnlyFullDefaultView;

    /**
     * Get the current publish status of a report
     *
     * @return read only publish status
     */
    public boolean getReadOnlyFullEnabled() {
        return readOnlyFullEnabled;
    }

    /**
     * If true, a rich version of the report is published
     *
     * @param readOnlyFullEnabled report publish status
     */
    public ReportPublish setReadOnlyFullEnabled(boolean readOnlyFullEnabled) {
        this.readOnlyFullEnabled = readOnlyFullEnabled;
        return this;
    }

    /**
     * Get who can see the published report. Only available when readOnlyFullEnabled = true
     *
     * @return String containing "ALL" - anyone, "ORG" - owner organization members
     */
    public String getReadOnlyFullAccessibleBy() {
        return readOnlyFullAccessibleBy;
    }

    /**
     * Set parameter indicating who can see the published report. Only valid when
     * readOnlyFullEnabled = true.
     *
     * @param readOnlyFullAccessibleBy - valid options are "ALL" and "ORG"
     */
    public ReportPublish setReadOnlyFullAccessibleBy(String readOnlyFullAccessibleBy) {
        this.readOnlyFullAccessibleBy = readOnlyFullAccessibleBy;
        return this;
    }

    /**
     * Get the URL of the published report. Valid only if readOnlyFullEnabled = true.
     *
     * @return String containing the URL of the published report.
     */
    public String getReadOnlyFullUrl() {
        return readOnlyFullUrl;
    }

    /**
     * Get the read only full show toolbar flag
     *
     * @return readOnlyFullShowToolbar
     */
    public Boolean getReadOnlyFullShowToolbar() {
        return readOnlyFullShowToolbar;
    }

    /**
     * Set the read only full show toolbar flag
     */
    public ReportPublish setReadOnlyFullShowToolbar(Boolean readOnlyFullShowToolbar) {
        this.readOnlyFullShowToolbar = readOnlyFullShowToolbar;
        return this;
    }

    /**
     * Get the read only full default view
     *
     * @return readOnlyFullDefaultView. Valid options are "GRID", "CARDS", "CALENDAR"
     */
    public String getReadOnlyFullDefaultView() {
        return readOnlyFullDefaultView;
    }

    /**
     * Set the read only full default view
     *
     * @param readOnlyFullDefaultView Valid options are "GRID", "CARDS", "CALENDAR"
     * @return the ReportPublish
     */
    public ReportPublish setReadOnlyFullDefaultView(String readOnlyFullDefaultView) {
        this.readOnlyFullDefaultView = readOnlyFullDefaultView;
        return this;
    }
}

1	/*
2	* Copyright (C) 2024 Smartsheet
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* http://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16
17	package com.smartsheet.api.models;
18
19	/**
20	* The ReportPublish object. Retruned by endpoints such as the
21	*
22	* @see <a href="https://smartsheet.redoc.ly/tag/sheets#operation/get-sheetPublish">get sheet publish status</a>
23	*/
24	public class ReportPublish {	×
25
26	/**
27	* Represents the current publish status of the report.
28	*/
29	private boolean readOnlyFullEnabled;
30
31	/**
32	* Indicates who can see the published report
33	* If "ALL", report is available to anyone who has the link.
34	* If "ORG", report is available only to members of the report owner's organization.
35	*/
36	private String readOnlyFullAccessibleBy;
37
38	/**
39	* String containing the URL of the published report.
40	*/
41	private String readOnlyFullUrl;
42
43	/**
44	* Flag to show or hide the left nav toolbar for the read only report.
45	*/
46	private Boolean readOnlyFullShowToolbar;
47
48	/**
49	* Default view for published report. (GRID, CARDS, CALENDAR)
50	*/
51	private String readOnlyFullDefaultView;
52
53	/**
54	* Get the current publish status of a report
55	*
56	* @return read only publish status
57	*/
58	public boolean getReadOnlyFullEnabled() {
59	return readOnlyFullEnabled;	×
60	}
61
62	/**
63	* If true, a rich version of the report is published
64	*
65	* @param readOnlyFullEnabled report publish status
66	*/
67	public ReportPublish setReadOnlyFullEnabled(boolean readOnlyFullEnabled) {
68	this.readOnlyFullEnabled = readOnlyFullEnabled;	×
69	return this;	×
70	}
71
72	/**
73	* Get who can see the published report. Only available when readOnlyFullEnabled = true
74	*
75	* @return String containing "ALL" - anyone, "ORG" - owner organization members
76	*/
77	public String getReadOnlyFullAccessibleBy() {
78	return readOnlyFullAccessibleBy;	×
79	}
80
81	/**
82	* Set parameter indicating who can see the published report. Only valid when
83	* readOnlyFullEnabled = true.
84	*
85	* @param readOnlyFullAccessibleBy - valid options are "ALL" and "ORG"
86	*/
87	public ReportPublish setReadOnlyFullAccessibleBy(String readOnlyFullAccessibleBy) {
88	this.readOnlyFullAccessibleBy = readOnlyFullAccessibleBy;	×
89	return this;	×
90	}
91
92	/**
93	* Get the URL of the published report. Valid only if readOnlyFullEnabled = true.
94	*
95	* @return String containing the URL of the published report.
96	*/
97	public String getReadOnlyFullUrl() {
98	return readOnlyFullUrl;	×
99	}
100
101	/**
102	* Get the read only full show toolbar flag
103	*
104	* @return readOnlyFullShowToolbar
105	*/
106	public Boolean getReadOnlyFullShowToolbar() {
107	return readOnlyFullShowToolbar;	×
108	}
109
110	/**
111	* Set the read only full show toolbar flag
112	*/
113	public ReportPublish setReadOnlyFullShowToolbar(Boolean readOnlyFullShowToolbar) {
114	this.readOnlyFullShowToolbar = readOnlyFullShowToolbar;	×
115	return this;	×
116	}
117
118	/**
119	* Get the read only full default view
120	*
121	* @return readOnlyFullDefaultView. Valid options are "GRID", "CARDS", "CALENDAR"
122	*/
123	public String getReadOnlyFullDefaultView() {
124	return readOnlyFullDefaultView;	×
125	}
126
127	/**
128	* Set the read only full default view
129	*
130	* @param readOnlyFullDefaultView Valid options are "GRID", "CARDS", "CALENDAR"
131	* @return the ReportPublish
132	*/
133	public ReportPublish setReadOnlyFullDefaultView(String readOnlyFullDefaultView) {
134	this.readOnlyFullDefaultView = readOnlyFullDefaultView;	×
135	return this;	×
136	}
137	}

smartsheet / smartsheet-java-sdk / #55

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous