smartsheet / smartsheet-java-sdk / #41

Committed 24 Aug 2023 04:59PM UTC coverage: 50.458% (+0.01%) from 50.444%

Build # #41

Build Type

push

github-actions

Committed by

web-flow

Commit Message

Fix Checkstyle Violations in "Impl" Classes (#53)

Run Details

241 of 241 new or added lines in 32 files covered. (100.0%)

3417 of 6772 relevant lines covered (50.46%)

0.5 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/SummaryField.java

package com.smartsheet.api.models;

/*
 * #[license]
 * Smartsheet Java SDK
 * %%
 * 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.
 * %[license]
 */

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.smartsheet.api.models.enums.ColumnType;
import com.smartsheet.api.models.format.Format;

import java.util.Date;
import java.util.List;

public class SummaryField extends IdentifiableModel<Long> {

    @Override
    @JsonIgnore(false)
    public Long getId() {
        return super.getId();
    }

    @Override
    @JsonIgnore(false)
    public IdentifiableModel<Long> setId(Long id) {
        super.setId(id);
        return this;
    }

    /**
     * Array of ContactOption objects to specify a pre-defined list of values for the column.
     * Column type must be CONTACT_LIST
     */
    private List<Contact> contactOptions;

    /**
     * Time of creation
     */
    private Date createdAt;

    /**
     * User object containing name and email of the summaryField's author
     */
    private User createdBy;

    /**
     * Visual representation of cell contents, as presented to the user in the UI. See Cell Reference.
     */
    private String displayValue;

    /**
     * The format descriptor (see Formatting)
     * Only returned if the include query string parameter contains format and this column has a non-default
     * format applied to it.
     */
    private Format format;

    /**
     * The formula for a cell, if set. NOTE: calculation errors or problems with a formula do not cause the API call
     * to return an error code. Instead, the response contains the same value as in the UI,
     * such as field.value = "#CIRCULAR REFERENCE".
     */
    private String formula;

    /**
     * A hyperlink to a URL, sheet, or report
     */
    private Hyperlink hyperlink;

    /**
     * The image that the field contains.
     * Only returned if the field contains an image.
     */
    private Image image;

    /**
     * Field index or position. This number is zero-based.
     */
    private Integer index;

    /**
     * Indicates whether the field is locked. In a response, a value of true indicates that the field has been
     * locked by the sheet owner or the admin.
     */
    private Boolean locked;

    /**
     * Indicates whether the field is locked for the requesting user. This attribute may be present in a response,
     * but cannot be specified in a request.
     */
    private Boolean lockedForUser;

    /**
     * Time of last modification
     */
    private Date modifiedAt;

    /**
     * User object containing name and email of the summaryField's author
     */
    private User modifiedBy;

    /**
     * Required for date and contact fields
     */
    private ObjectValue objectValue;

    /**
     * When applicable for PICKLIST column type. Array of the options available for the field
     */
    private List<String> options;

    /**
     * When applicable for PICKLIST column type. See Symbol Columns.
     */
    private String symbol;

    /**
     * Arbitrary name, must be unique within summary
     */
    private String title;

    /**
     * See Column Types.
     */
    private ColumnType type;

    /**
     * Indicates whether summary field values are restricted to the type
     */
    private Boolean validation;

    /**
     * Get contact options, only valid when type is CONTACT_LIST
     *
     * @return contactOptions
     */
    public List<Contact> getContactOptions() {
        return contactOptions;
    }

    /**
     * Set contact options
     */
    public SummaryField setContactOptions(List<Contact> contactOptions) {
        this.contactOptions = contactOptions;
        return this;
    }

    /**
     * Get summary field time of creation
     *
     * @return createdAt
     */
    public Date getCreatedAt() {
        return createdAt;
    }

    /**
     * Set summary field time of creation
     */
    public SummaryField setCreatedAt(Date createdAt) {
        this.createdAt = createdAt;
        return this;
    }

    /**
     * Get User object of summary field creator
     *
     * @return createdBy
     */
    public User getCreatedBy() {
        return createdBy;
    }

    /**
     * Set User object of summary field creator
     */
    public SummaryField setCreatedBy(User createdBy) {
        this.createdBy = createdBy;
        return this;
    }

    /**
     * Gets the display value of the summary field
     *
     * @return displayValue
     */
    public String getDisplayValue() {
        return displayValue;
    }

    /**
     * Sets the display value of the summary field
     */
    public SummaryField setDisplayValue(String displayValue) {
        this.displayValue = displayValue;
        return this;
    }

    /**
     * Gets the format descriptor
     *
     * @return format
     */
    public Format getFormat() {
        return format;
    }

    /**
     * Sets the format descriptor
     */
    public SummaryField setFormat(Format format) {
        this.format = format;
        return this;
    }

    /**
     * Gets the formula for the summary field
     *
     * @return formula
     */
    public String getFormula() {
        return formula;
    }

    /**
     * Sets the formula for the summary field
     */
    public SummaryField setFormula(String formula) {
        this.formula = formula;
        return this;
    }

    /**
     * Gets the hyperlink associated with the field, if any
     *
     * @return hyperlink
     */
    public Hyperlink getHyperlink() {
        return hyperlink;
    }

    /**
     * Sets the hyperlink associated with the field
     */
    public SummaryField setHyperlink(Hyperlink hyperlink) {
        this.hyperlink = hyperlink;
        return this;
    }

    /**
     * Gets the image associated with the field, if any
     *
     * @return image
     */
    public Image getImage() {
        return image;
    }

    /**
     * Sets the image associated with the field
     */
    public SummaryField setImage(Image image) {
        this.image = image;
        return this;
    }

    /**
     * Gets the field index or position
     *
     * @return index
     */
    public Integer getIndex() {
        return index;
    }

    /**
     * Sets the field index or position
     */
    public SummaryField setIndex(Integer index) {
        this.index = index;
        return this;
    }

    /**
     * Gets flag indicating if field is locked
     *
     * @return locked
     */
    public Boolean getLocked() {
        return locked;
    }

    /**
     * Sets flag indicating if field is locked
     */
    public SummaryField setLocked(Boolean locked) {
        this.locked = locked;
        return this;
    }

    /**
     * Gets flag indicating whether field is locked for the requesting user
     *
     * @return lockedForUser
     */
    public Boolean getLockedForUser() {
        return lockedForUser;
    }

    /**
     * Sets flag indicating whether field is locked for the requesting user
     */
    public SummaryField setLockedForUser(Boolean lockedForUser) {
        this.lockedForUser = lockedForUser;
        return this;
    }

    /**
     * Gets the last modification date and time
     *
     * @return modifiedAt
     */
    public Date getModifiedAt() {
        return modifiedAt;
    }

    /**
     * Sets the last modification date and time
     */
    public SummaryField setModifiedAt(Date modifiedAt) {
        this.modifiedAt = modifiedAt;
        return this;
    }

    /**
     * Get the User who last modified the field
     *
     * @return modifiedBy
     */
    public User getModifiedBy() {
        return modifiedBy;
    }

    /**
     * Sets the User who last modified the field
     */
    public SummaryField setModifiedBy(User modifiedBy) {
        this.modifiedBy = modifiedBy;
        return this;
    }

    /**
     * Gets the field's objectValue
     *
     * @return objectValue
     */
    public ObjectValue getObjectValue() {
        return objectValue;
    }

    /**
     * Sets the field's objectValue
     */
    public SummaryField setObjectValue(ObjectValue objectValue) {
        this.objectValue = objectValue;
        return this;
    }

    /**
     * Gets PICKLIST options
     *
     * @return options
     */
    public List<String> getOptions() {
        return options;
    }

    /**
     * Sets PICKLIST options
     */
    public SummaryField setOptions(List<String> options) {
        this.options = options;
        return this;
    }

    /**
     * Gets applicable symbol for PICKLIST type
     *
     * @return symbol
     */
    public String getSymbol() {
        return symbol;
    }

    /**
     * Sets applicable symbo for PICKLIST type
     */
    public SummaryField setSymbol(String symbol) {
        this.symbol = symbol;
        return this;
    }

    /**
     * Gets the field's title
     *
     * @return title
     */
    public String getTitle() {
        return title;
    }

    /**
     * Sets the field's title
     */
    public SummaryField setTitle(String title) {
        this.title = title;
        return this;
    }

    /**
     * Gets the field's type - see Column Type
     *
     * @return type
     */
    public ColumnType getType() {
        return type;
    }

    /**
     * Sets the field's type - see Column Type
     */
    public SummaryField setType(ColumnType type) {
        this.type = type;
        return this;
    }

    /**
     * Gets flag indicating whether summary field values are restricted to type
     *
     * @return validation
     */
    public Boolean getValidation() {
        return validation;
    }

    /**
     * Sets flag indicating whether summary field values are restricted to type
     */
    public SummaryField setValidation(Boolean validation) {
        this.validation = validation;
        return this;
    }
}

1	package com.smartsheet.api.models;
2
3	/*
4	* #[license]
5	* Smartsheet Java SDK
6	* %%
7	* Copyright (C) 2023 Smartsheet
8	* %%
9	* Licensed under the Apache License, Version 2.0 (the "License");
10	* you may not use this file except in compliance with the License.
11	* You may obtain a copy of the License at
12	*
13	* http://www.apache.org/licenses/LICENSE-2.0
14	*
15	* Unless required by applicable law or agreed to in writing, software
16	* distributed under the License is distributed on an "AS IS" BASIS,
17	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18	* See the License for the specific language governing permissions and
19	* limitations under the License.
20	* %[license]
21	*/
22
23	import com.fasterxml.jackson.annotation.JsonIgnore;
24	import com.smartsheet.api.models.enums.ColumnType;
25	import com.smartsheet.api.models.format.Format;
26
27	import java.util.Date;
28	import java.util.List;
29
30	public class SummaryField extends IdentifiableModel<Long> {	×
31
32	@Override
33	@JsonIgnore(false)
34	public Long getId() {
35	return super.getId();	×
36	}
37
38	@Override
39	@JsonIgnore(false)
40	public IdentifiableModel<Long> setId(Long id) {
41	super.setId(id);	×
42	return this;	×
43	}
44
45	/**
46	* Array of ContactOption objects to specify a pre-defined list of values for the column.
47	* Column type must be CONTACT_LIST
48	*/
49	private List<Contact> contactOptions;
50
51	/**
52	* Time of creation
53	*/
54	private Date createdAt;
55
56	/**
57	* User object containing name and email of the summaryField's author
58	*/
59	private User createdBy;
60
61	/**
62	* Visual representation of cell contents, as presented to the user in the UI. See Cell Reference.
63	*/
64	private String displayValue;
65
66	/**
67	* The format descriptor (see Formatting)
68	* Only returned if the include query string parameter contains format and this column has a non-default
69	* format applied to it.
70	*/
71	private Format format;
72
73	/**
74	* The formula for a cell, if set. NOTE: calculation errors or problems with a formula do not cause the API call
75	* to return an error code. Instead, the response contains the same value as in the UI,
76	* such as field.value = "#CIRCULAR REFERENCE".
77	*/
78	private String formula;
79
80	/**
81	* A hyperlink to a URL, sheet, or report
82	*/
83	private Hyperlink hyperlink;
84
85	/**
86	* The image that the field contains.
87	* Only returned if the field contains an image.
88	*/
89	private Image image;
90
91	/**
92	* Field index or position. This number is zero-based.
93	*/
94	private Integer index;
95
96	/**
97	* Indicates whether the field is locked. In a response, a value of true indicates that the field has been
98	* locked by the sheet owner or the admin.
99	*/
100	private Boolean locked;
101
102	/**
103	* Indicates whether the field is locked for the requesting user. This attribute may be present in a response,
104	* but cannot be specified in a request.
105	*/
106	private Boolean lockedForUser;
107
108	/**
109	* Time of last modification
110	*/
111	private Date modifiedAt;
112
113	/**
114	* User object containing name and email of the summaryField's author
115	*/
116	private User modifiedBy;
117
118	/**
119	* Required for date and contact fields
120	*/
121	private ObjectValue objectValue;
122
123	/**
124	* When applicable for PICKLIST column type. Array of the options available for the field
125	*/
126	private List<String> options;
127
128	/**
129	* When applicable for PICKLIST column type. See Symbol Columns.
130	*/
131	private String symbol;
132
133	/**
134	* Arbitrary name, must be unique within summary
135	*/
136	private String title;
137
138	/**
139	* See Column Types.
140	*/
141	private ColumnType type;
142
143	/**
144	* Indicates whether summary field values are restricted to the type
145	*/
146	private Boolean validation;
147
148	/**
149	* Get contact options, only valid when type is CONTACT_LIST
150	*
151	* @return contactOptions
152	*/
153	public List<Contact> getContactOptions() {
154	return contactOptions;	×
155	}
156
157	/**
158	* Set contact options
159	*/
160	public SummaryField setContactOptions(List<Contact> contactOptions) {
161	this.contactOptions = contactOptions;	×
162	return this;	×
163	}
164
165	/**
166	* Get summary field time of creation
167	*
168	* @return createdAt
169	*/
170	public Date getCreatedAt() {
171	return createdAt;	×
172	}
173
174	/**
175	* Set summary field time of creation
176	*/
177	public SummaryField setCreatedAt(Date createdAt) {
178	this.createdAt = createdAt;	×
179	return this;	×
180	}
181
182	/**
183	* Get User object of summary field creator
184	*
185	* @return createdBy
186	*/
187	public User getCreatedBy() {
188	return createdBy;	×
189	}
190
191	/**
192	* Set User object of summary field creator
193	*/
194	public SummaryField setCreatedBy(User createdBy) {
195	this.createdBy = createdBy;	×
196	return this;	×
197	}
198
199	/**
200	* Gets the display value of the summary field
201	*
202	* @return displayValue
203	*/
204	public String getDisplayValue() {
205	return displayValue;	×
206	}
207
208	/**
209	* Sets the display value of the summary field
210	*/
211	public SummaryField setDisplayValue(String displayValue) {
212	this.displayValue = displayValue;	×
213	return this;	×
214	}
215
216	/**
217	* Gets the format descriptor
218	*
219	* @return format
220	*/
221	public Format getFormat() {
222	return format;	×
223	}
224
225	/**
226	* Sets the format descriptor
227	*/
228	public SummaryField setFormat(Format format) {
229	this.format = format;	×
230	return this;	×
231	}
232
233	/**
234	* Gets the formula for the summary field
235	*
236	* @return formula
237	*/
238	public String getFormula() {
239	return formula;	×
240	}
241
242	/**
243	* Sets the formula for the summary field
244	*/
245	public SummaryField setFormula(String formula) {
246	this.formula = formula;	×
247	return this;	×
248	}
249
250	/**
251	* Gets the hyperlink associated with the field, if any
252	*
253	* @return hyperlink
254	*/
255	public Hyperlink getHyperlink() {
256	return hyperlink;	×
257	}
258
259	/**
260	* Sets the hyperlink associated with the field
261	*/
262	public SummaryField setHyperlink(Hyperlink hyperlink) {
263	this.hyperlink = hyperlink;	×
264	return this;	×
265	}
266
267	/**
268	* Gets the image associated with the field, if any
269	*
270	* @return image
271	*/
272	public Image getImage() {
273	return image;	×
274	}
275
276	/**
277	* Sets the image associated with the field
278	*/
279	public SummaryField setImage(Image image) {
280	this.image = image;	×
281	return this;	×
282	}
283
284	/**
285	* Gets the field index or position
286	*
287	* @return index
288	*/
289	public Integer getIndex() {
290	return index;	×
291	}
292
293	/**
294	* Sets the field index or position
295	*/
296	public SummaryField setIndex(Integer index) {
297	this.index = index;	×
298	return this;	×
299	}
300
301	/**
302	* Gets flag indicating if field is locked
303	*
304	* @return locked
305	*/
306	public Boolean getLocked() {
307	return locked;	×
308	}
309
310	/**
311	* Sets flag indicating if field is locked
312	*/
313	public SummaryField setLocked(Boolean locked) {
314	this.locked = locked;	×
315	return this;	×
316	}
317
318	/**
319	* Gets flag indicating whether field is locked for the requesting user
320	*
321	* @return lockedForUser
322	*/
323	public Boolean getLockedForUser() {
324	return lockedForUser;	×
325	}
326
327	/**
328	* Sets flag indicating whether field is locked for the requesting user
329	*/
330	public SummaryField setLockedForUser(Boolean lockedForUser) {
331	this.lockedForUser = lockedForUser;	×
332	return this;	×
333	}
334
335	/**
336	* Gets the last modification date and time
337	*
338	* @return modifiedAt
339	*/
340	public Date getModifiedAt() {
341	return modifiedAt;	×
342	}
343
344	/**
345	* Sets the last modification date and time
346	*/
347	public SummaryField setModifiedAt(Date modifiedAt) {
348	this.modifiedAt = modifiedAt;	×
349	return this;	×
350	}
351
352	/**
353	* Get the User who last modified the field
354	*
355	* @return modifiedBy
356	*/
357	public User getModifiedBy() {
358	return modifiedBy;	×
359	}
360
361	/**
362	* Sets the User who last modified the field
363	*/
364	public SummaryField setModifiedBy(User modifiedBy) {
365	this.modifiedBy = modifiedBy;	×
366	return this;	×
367	}
368
369	/**
370	* Gets the field's objectValue
371	*
372	* @return objectValue
373	*/
374	public ObjectValue getObjectValue() {
375	return objectValue;	×
376	}
377
378	/**
379	* Sets the field's objectValue
380	*/
381	public SummaryField setObjectValue(ObjectValue objectValue) {
382	this.objectValue = objectValue;	×
383	return this;	×
384	}
385
386	/**
387	* Gets PICKLIST options
388	*
389	* @return options
390	*/
391	public List<String> getOptions() {
392	return options;	×
393	}
394
395	/**
396	* Sets PICKLIST options
397	*/
398	public SummaryField setOptions(List<String> options) {
399	this.options = options;	×
400	return this;	×
401	}
402
403	/**
404	* Gets applicable symbol for PICKLIST type
405	*
406	* @return symbol
407	*/
408	public String getSymbol() {
409	return symbol;	×
410	}
411
412	/**
413	* Sets applicable symbo for PICKLIST type
414	*/
415	public SummaryField setSymbol(String symbol) {
416	this.symbol = symbol;	×
417	return this;	×
418	}
419
420	/**
421	* Gets the field's title
422	*
423	* @return title
424	*/
425	public String getTitle() {
426	return title;	×
427	}
428
429	/**
430	* Sets the field's title
431	*/
432	public SummaryField setTitle(String title) {
433	this.title = title;	×
434	return this;	×
435	}
436
437	/**
438	* Gets the field's type - see Column Type
439	*
440	* @return type
441	*/
442	public ColumnType getType() {
443	return type;	×
444	}
445
446	/**
447	* Sets the field's type - see Column Type
448	*/
449	public SummaryField setType(ColumnType type) {
450	this.type = type;	×
451	return this;	×
452	}
453
454	/**
455	* Gets flag indicating whether summary field values are restricted to type
456	*
457	* @return validation
458	*/
459	public Boolean getValidation() {
460	return validation;	×
461	}
462
463	/**
464	* Sets flag indicating whether summary field values are restricted to type
465	*/
466	public SummaryField setValidation(Boolean validation) {
467	this.validation = validation;	×
468	return this;	×
469	}
470	}

smartsheet / smartsheet-java-sdk / #41

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