smartsheet / smartsheet-java-sdk / #43

Committed 24 Aug 2023 10:26PM UTC coverage: 50.427% (-0.02%) from 50.442%

Build # #43

Build Type

push

github-actions

Committed by

web-flow

Commit Message

Fix Checkstyle violations in api/models Classes (#57)

This will fix ~900 violations

Run Details

189 of 189 new or added lines in 59 files covered. (100.0%)

3423 of 6788 relevant lines covered (50.43%)

0.5 hits per line

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

64.71

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

package com.smartsheet.api.models;

/*
 * #[license]
 * Smartsheet SDK for Java
 * %%
 * 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.smartsheet.api.models.enums.AttachmentType;

import java.util.List;

/**
 * Represents one specific result of a search.
 */
public class SearchResultItem {
    /**
     * Represents the text for this specific search result.
     */
    private String text;

    /**
     * Represents the object ID for this specific search result.
     */
    private Long objectId;

    /**
     * Represents the object type (row, discussion, attach) for this specific search result.
     */
    private String objectType;

    /**
     * Represents the parent object ID for this specific search result.
     */
    private Long parentObjectId;

    /**
     * Represents the parent object type for this specific search result.
     */
    private String parentObjectType;

    /**
     * Represents the parent object name for this specific search result.
     */
    private String parentObjectName;

    /**
     * Represents the context data for this specific search result.
     */
    private List<String> contextData;

    /**
     * Represents the attachment type if the search result item is an attachment.
     */
    private AttachmentType attachmentType;

    /**
     * Represents the MIME type.
     */
    private String mimeType;

    /**
     * If the search result item is a favorite
     */
    private Boolean favorite;

    /**
     * If the parent object of the search item is a favorite
     */
    private Boolean parentObjectFavorite;

    /**
     * Gets the text for this specific search result.
     *
     * @return the text
     */
    public String getText() {
        return text;
    }

    /**
     * Sets the text for this specific search result.
     *
     * @param text the new text
     */
    public void setText(String text) {
        this.text = text;
    }

    /**
     * Gets the object id for this specific search result.
     *
     * @return the object id
     */
    public Long getObjectId() {
        return objectId;
    }

    /**
     * Sets the object id for this specific search result.
     *
     * @param objectId the new object id
     */
    public void setObjectId(Long objectId) {
        this.objectId = objectId;
    }

    /**
     * Gets the object type for this specific search result.
     *
     * @return the object type
     */
    public String getObjectType() {
        return objectType;
    }

    /**
     * Sets the object type for this specific search result.
     *
     * @param objectType the new object type
     */
    public void setObjectType(String objectType) {
        this.objectType = objectType;
    }

    /**
     * Gets the parent object id for this specific search result.
     *
     * @return the parent object id
     */
    public Long getParentObjectId() {
        return parentObjectId;
    }

    /**
     * Sets the parent object id for this specific search result.
     *
     * @param parentObjectId the new parent object id
     */
    public void setParentObjectId(Long parentObjectId) {
        this.parentObjectId = parentObjectId;
    }

    /**
     * Gets the parent object type for this specific search result.
     *
     * @return the parent object type
     */
    public String getParentObjectType() {
        return parentObjectType;
    }

    /**
     * Sets the parent object type for this specific search result.
     *
     * @param parentObjectType the new parent object type
     */
    public void setParentObjectType(String parentObjectType) {
        this.parentObjectType = parentObjectType;
    }

    /**
     * Gets the parent object name for this specific search result.
     *
     * @return the parent object name
     */
    public String getParentObjectName() {
        return parentObjectName;
    }

    /**
     * Sets the parent object name for this specific search result.
     *
     * @param parentObjectName the new parent object name
     */
    public void setParentObjectName(String parentObjectName) {
        this.parentObjectName = parentObjectName;
    }

    /**
     * Gets the context data for this specific search result.
     *
     * @return the context data
     */
    public List<String> getContextData() {
        return contextData;
    }

    /**
     * Sets the context data for this specific search result.
     *
     * @param contextData the new context data
     */
    public void setContextData(List<String> contextData) {
        this.contextData = contextData;
    }

    /**
     * Get the attachment type if the search result item is an attachment
     *
     * @return the attachment type
     */
    public AttachmentType getAttachmentType() {
        return attachmentType;
    }

    /**
     * Set the attachment type if the search result item is an attachment
     *
     * @param attachmentType the attachment type
     */
    public void setAttachmentType(AttachmentType attachmentType) {
        this.attachmentType = attachmentType;
    }

    /**
     * Gets the mime type.
     *
     * @return the mime type
     */
    public String getMimeType() {
        return mimeType;
    }

    /**
     * Sets the mime type.
     *
     * @param mimeType the new mime type
     */
    public void setMimeType(String mimeType) {
        this.mimeType = mimeType;
    }

    /**
     * Get a flag indicating if the search result item is a favorite
     *
     * @return the favorite flag
     */
    public Boolean getFavorite() {
        return favorite;
    }

    /**
     * Set a flag indicating if the search result item is a favorite
     *
     * @param favorite the favorite flag
     */
    public void setFavorite(Boolean favorite) {
        this.favorite = favorite;
    }

    /**
     * Get a flag indicating if the search result item parent is a favorite
     *
     * @return the favorite flag
     */
    public Boolean getParentObjectFavorite() {
        return parentObjectFavorite;
    }

    /**
     * Set a flag indicating if the search result item parent is a favorite
     *
     * @param parentObjectFavorite the favorite flag
     */
    public void setParentObjectFavorite(Boolean parentObjectFavorite) {
        this.parentObjectFavorite = parentObjectFavorite;
    }
}

1	package com.smartsheet.api.models;
2
3	/*
4	* #[license]
5	* Smartsheet SDK for Java
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.smartsheet.api.models.enums.AttachmentType;
24
25	import java.util.List;
26
27	/**
28	* Represents one specific result of a search.
29	*/
30	public class SearchResultItem {	1✔
31	/**
32	* Represents the text for this specific search result.
33	*/
34	private String text;
35
36	/**
37	* Represents the object ID for this specific search result.
38	*/
39	private Long objectId;
40
41	/**
42	* Represents the object type (row, discussion, attach) for this specific search result.
43	*/
44	private String objectType;
45
46	/**
47	* Represents the parent object ID for this specific search result.
48	*/
49	private Long parentObjectId;
50
51	/**
52	* Represents the parent object type for this specific search result.
53	*/
54	private String parentObjectType;
55
56	/**
57	* Represents the parent object name for this specific search result.
58	*/
59	private String parentObjectName;
60
61	/**
62	* Represents the context data for this specific search result.
63	*/
64	private List<String> contextData;
65
66	/**
67	* Represents the attachment type if the search result item is an attachment.
68	*/
69	private AttachmentType attachmentType;
70
71	/**
72	* Represents the MIME type.
73	*/
74	private String mimeType;
75
76	/**
77	* If the search result item is a favorite
78	*/
79	private Boolean favorite;
80
81	/**
82	* If the parent object of the search item is a favorite
83	*/
84	private Boolean parentObjectFavorite;
85
86	/**
87	* Gets the text for this specific search result.
88	*
89	* @return the text
90	*/
91	public String getText() {
92	return text;	1✔
93	}
94
95	/**
96	* Sets the text for this specific search result.
97	*
98	* @param text the new text
99	*/
100	public void setText(String text) {
101	this.text = text;	1✔
102	}	1✔
103
104	/**
105	* Gets the object id for this specific search result.
106	*
107	* @return the object id
108	*/
109	public Long getObjectId() {
110	return objectId;	1✔
111	}
112
113	/**
114	* Sets the object id for this specific search result.
115	*
116	* @param objectId the new object id
117	*/
118	public void setObjectId(Long objectId) {
119	this.objectId = objectId;	1✔
120	}	1✔
121
122	/**
123	* Gets the object type for this specific search result.
124	*
125	* @return the object type
126	*/
127	public String getObjectType() {
128	return objectType;	1✔
129	}
130
131	/**
132	* Sets the object type for this specific search result.
133	*
134	* @param objectType the new object type
135	*/
136	public void setObjectType(String objectType) {
137	this.objectType = objectType;	1✔
138	}	1✔
139
140	/**
141	* Gets the parent object id for this specific search result.
142	*
143	* @return the parent object id
144	*/
145	public Long getParentObjectId() {
146	return parentObjectId;	1✔
147	}
148
149	/**
150	* Sets the parent object id for this specific search result.
151	*
152	* @param parentObjectId the new parent object id
153	*/
154	public void setParentObjectId(Long parentObjectId) {
155	this.parentObjectId = parentObjectId;	1✔
156	}	1✔
157
158	/**
159	* Gets the parent object type for this specific search result.
160	*
161	* @return the parent object type
162	*/
163	public String getParentObjectType() {
164	return parentObjectType;	1✔
165	}
166
167	/**
168	* Sets the parent object type for this specific search result.
169	*
170	* @param parentObjectType the new parent object type
171	*/
172	public void setParentObjectType(String parentObjectType) {
173	this.parentObjectType = parentObjectType;	1✔
174	}	1✔
175
176	/**
177	* Gets the parent object name for this specific search result.
178	*
179	* @return the parent object name
180	*/
181	public String getParentObjectName() {
182	return parentObjectName;	1✔
183	}
184
185	/**
186	* Sets the parent object name for this specific search result.
187	*
188	* @param parentObjectName the new parent object name
189	*/
190	public void setParentObjectName(String parentObjectName) {
191	this.parentObjectName = parentObjectName;	1✔
192	}	1✔
193
194	/**
195	* Gets the context data for this specific search result.
196	*
197	* @return the context data
198	*/
199	public List<String> getContextData() {
200	return contextData;	1✔
201	}
202
203	/**
204	* Sets the context data for this specific search result.
205	*
206	* @param contextData the new context data
207	*/
208	public void setContextData(List<String> contextData) {
209	this.contextData = contextData;	1✔
210	}	1✔
211
212	/**
213	* Get the attachment type if the search result item is an attachment
214	*
215	* @return the attachment type
216	*/
217	public AttachmentType getAttachmentType() {
218	return attachmentType;	×
219	}
220
221	/**
222	* Set the attachment type if the search result item is an attachment
223	*
224	* @param attachmentType the attachment type
225	*/
226	public void setAttachmentType(AttachmentType attachmentType) {
227	this.attachmentType = attachmentType;	×
228	}	×
229
230	/**
231	* Gets the mime type.
232	*
233	* @return the mime type
234	*/
235	public String getMimeType() {
236	return mimeType;	×
237	}
238
239	/**
240	* Sets the mime type.
241	*
242	* @param mimeType the new mime type
243	*/
244	public void setMimeType(String mimeType) {
245	this.mimeType = mimeType;	×
246	}	×
247
248	/**
249	* Get a flag indicating if the search result item is a favorite
250	*
251	* @return the favorite flag
252	*/
253	public Boolean getFavorite() {
254	return favorite;	×
255	}
256
257	/**
258	* Set a flag indicating if the search result item is a favorite
259	*
260	* @param favorite the favorite flag
261	*/
262	public void setFavorite(Boolean favorite) {
263	this.favorite = favorite;	×
264	}	×
265
266	/**
267	* Get a flag indicating if the search result item parent is a favorite
268	*
269	* @return the favorite flag
270	*/
271	public Boolean getParentObjectFavorite() {
272	return parentObjectFavorite;	×
273	}
274
275	/**
276	* Set a flag indicating if the search result item parent is a favorite
277	*
278	* @param parentObjectFavorite the favorite flag
279	*/
280	public void setParentObjectFavorite(Boolean parentObjectFavorite) {
281	this.parentObjectFavorite = parentObjectFavorite;	×
282	}	×
283	}

smartsheet / smartsheet-java-sdk / #43

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