1 /**
2 * Copyright 2014 Internet2
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 * @author mchyzer
18 * $Id: WsRestGetGroupsRequest.java,v 1.2 2009-12-10 08:54:32 mchyzer Exp $
19 */
20 package edu.internet2.middleware.grouperClient.ws.beans;
21
22 /**
23 * bean that will be the data from rest request
24 * for method
25 */
26 public class WsRestGetGroupsRequest implements WsRequestBean {
27
28 /** field */
29 private String clientVersion;
30
31 /** field */
32 private WsSubjectLookup[] subjectLookups;
33
34 /** field */
35 private WsSubjectLookup actAsSubjectLookup;
36
37 /** field */
38 private String memberFilter;
39
40 /** field */
41 private String includeGroupDetail;
42
43 /** field */
44 private String includeSubjectDetail;
45
46 /** field */
47 private String[] subjectAttributeNames;
48
49 /** field */
50 private WsParam[] params;
51
52 /** scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent: */
53 private String scope;
54
55 /** is the stem to check in, or null if all. If has stem, must have stemScope */
56 private WsStemLookup wsStemLookup;
57
58 /** stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stem */
59 private String stemScope;
60
61 /** enabled is A for all, T or null for enabled only, F for disabled */
62 private String enabled;
63
64 /** pageSize page size if paging */
65 private String pageSize;
66
67 /** pageNumber page number 1 indexed if paging */
68 private String pageNumber;
69
70 /** sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension */
71 private String sortString;
72
73 /** ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string */
74 private String ascending;
75
76 /** field name (list) to search, blank for members list */
77 private String fieldName;
78
79 /**
80 * To query members at a certain point in time or time range in the past, set this value
81 * and/or the value of pointInTimeTo. This parameter specifies the start of the range
82 * of the point in time query. If this is specified but pointInTimeTo is not specified,
83 * then the point in time query range will be from the time specified to now.
84 * Format: yyyy/MM/dd HH:mm:ss.SSS
85 */
86 private String pointInTimeFrom;
87
88 /**
89 * To query members at a certain point in time or time range in the past, set this value
90 * and/or the value of pointInTimeFrom. This parameter specifies the end of the range
91 * of the point in time query. If this is the same as pointInTimeFrom, then the query
92 * will be done at a single point in time rather than a range. If this is specified but
93 * pointInTimeFrom is not specified, then the point in time query range will be from the
94 * minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS
95 */
96 private String pointInTimeTo;
97
98 /**
99 * field name (list) to search, blank for members list
100 * @return field name
101 */
102 public String getFieldName() {
103 return this.fieldName;
104 }
105
106 /**
107 * field name (list) to search, blank for members list
108 * @param fieldName1
109 */
110 public void setFieldName(String fieldName1) {
111 this.fieldName = fieldName1;
112 }
113
114 /**
115 * scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
116 * @return scope
117 */
118 public String getScope() {
119 return this.scope;
120 }
121
122
123 /**
124 * scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
125 * @param scope1
126 */
127 public void setScope(String scope1) {
128 this.scope = scope1;
129 }
130
131
132 /**
133 * is the stem to check in, or null if all. If has stem, must have stemScope
134 * @return stem lookup
135 */
136 public WsStemLookup getWsStemLookup() {
137 //TODO return the stem in the response somewhere
138 return this.wsStemLookup;
139 }
140
141
142 /**
143 * is the stem to check in, or null if all. If has stem, must have stemScope
144 * @param wsStemLookup1
145 */
146 public void setWsStemLookup(WsStemLookup wsStemLookup1) {
147 this.wsStemLookup = wsStemLookup1;
148 }
149
150
151 /**
152 * stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stem
153 * @return stem scope
154 */
155 public String getStemScope() {
156 return this.stemScope;
157 }
158
159
160 /**
161 * stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stem
162 * @param stemScope1
163 */
164 public void setStemScope(String stemScope1) {
165 this.stemScope = stemScope1;
166 }
167
168
169 /**
170 * enabled is A for all, T or null for enabled only, F for disabled
171 * @return enabled string
172 */
173 public String getEnabled() {
174 return this.enabled;
175 }
176
177
178 /**
179 * enabled is A for all, T or null for enabled only, F for disabled
180 * @param enabled1
181 */
182 public void setEnabled(String enabled1) {
183 this.enabled = enabled1;
184 }
185
186
187 /**
188 * pageSize page size if paging
189 * @return page size
190 */
191 public String getPageSize() {
192 return this.pageSize;
193 }
194
195
196 /**
197 * pageSize page size if paging
198 * @param pageSize1
199 */
200 public void setPageSize(String pageSize1) {
201 this.pageSize = pageSize1;
202 }
203
204
205 /**
206 * pageNumber page number 1 indexed if paging
207 * @return page number
208 */
209 public String getPageNumber() {
210 return this.pageNumber;
211 }
212
213
214 /**
215 * pageNumber page number 1 indexed if paging
216 * @param pageNumber1
217 */
218 public void setPageNumber(String pageNumber1) {
219 this.pageNumber = pageNumber1;
220 }
221
222
223 /**
224 * sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
225 * @return sort string
226 */
227 public String getSortString() {
228 return this.sortString;
229 }
230
231
232 /**
233 * sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
234 * @param sortString1
235 */
236 public void setSortString(String sortString1) {
237 this.sortString = sortString1;
238 }
239
240
241 /**
242 * ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string
243 * @return if ascending
244 */
245 public String getAscending() {
246 return this.ascending;
247 }
248
249
250 /**
251 * ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string
252 * @param ascending1
253 */
254 public void setAscending(String ascending1) {
255 this.ascending = ascending1;
256 }
257
258
259 /**
260 * @return the clientVersion
261 */
262 public String getClientVersion() {
263 return this.clientVersion;
264 }
265
266
267 /**
268 * @param clientVersion1 the clientVersion to set
269 */
270 public void setClientVersion(String clientVersion1) {
271 this.clientVersion = clientVersion1;
272 }
273
274
275 /**
276 * @return the subjectLookups
277 */
278 public WsSubjectLookup[] getSubjectLookups() {
279 return this.subjectLookups;
280 }
281
282
283 /**
284 * @param subjectLookups1 the subjectLookups to set
285 */
286 public void setSubjectLookups(WsSubjectLookup[] subjectLookups1) {
287 this.subjectLookups = subjectLookups1;
288 }
289
290
291 /**
292 * @return the actAsSubjectLookup
293 */
294 public WsSubjectLookup getActAsSubjectLookup() {
295 return this.actAsSubjectLookup;
296 }
297
298
299 /**
300 * @param actAsSubjectLookup1 the actAsSubjectLookup to set
301 */
302 public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1) {
303 this.actAsSubjectLookup = actAsSubjectLookup1;
304 }
305
306
307 /**
308 * @return the fieldName
309 */
310 public String getMemberFilter() {
311 return this.memberFilter;
312 }
313
314
315 /**
316 * @param fieldName1 the fieldName to set
317 */
318 public void setMemberFilter(String fieldName1) {
319 this.memberFilter = fieldName1;
320 }
321
322
323 /**
324 * @return the includeGroupDetail
325 */
326 public String getIncludeGroupDetail() {
327 return this.includeGroupDetail;
328 }
329
330
331 /**
332 * @param includeGroupDetail1 the includeGroupDetail to set
333 */
334 public void setIncludeGroupDetail(String includeGroupDetail1) {
335 this.includeGroupDetail = includeGroupDetail1;
336 }
337
338
339 /**
340 * @return the includeSubjectDetail
341 */
342 public String getIncludeSubjectDetail() {
343 return this.includeSubjectDetail;
344 }
345
346
347 /**
348 * @param includeSubjectDetail1 the includeSubjectDetail to set
349 */
350 public void setIncludeSubjectDetail(String includeSubjectDetail1) {
351 this.includeSubjectDetail = includeSubjectDetail1;
352 }
353
354
355 /**
356 * @return the subjectAttributeNames
357 */
358 public String[] getSubjectAttributeNames() {
359 return this.subjectAttributeNames;
360 }
361
362
363 /**
364 * @param subjectAttributeNames1 the subjectAttributeNames to set
365 */
366 public void setSubjectAttributeNames(String[] subjectAttributeNames1) {
367 this.subjectAttributeNames = subjectAttributeNames1;
368 }
369
370
371
372 /**
373 * @return the params
374 */
375 public WsParam[] getParams() {
376 return this.params;
377 }
378
379
380
381 /**
382 * @param params1 the params to set
383 */
384 public void setParams(WsParam[] params1) {
385 this.params = params1;
386 }
387
388 /**
389 * To query members at a certain point in time or time range in the past, set this value
390 * and/or the value of pointInTimeTo. This parameter specifies the start of the range
391 * of the point in time query. If this is specified but pointInTimeTo is not specified,
392 * then the point in time query range will be from the time specified to now.
393 * Format: yyyy/MM/dd HH:mm:ss.SSS
394 * @return the pointInTimeFrom
395 */
396 public String getPointInTimeFrom() {
397 return this.pointInTimeFrom;
398 }
399
400
401 /**
402 * To query members at a certain point in time or time range in the past, set this value
403 * and/or the value of pointInTimeTo. This parameter specifies the start of the range
404 * of the point in time query. If this is specified but pointInTimeTo is not specified,
405 * then the point in time query range will be from the time specified to now.
406 * Format: yyyy/MM/dd HH:mm:ss.SSS
407 * @param pointInTimeFrom1 the pointInTimeFrom to set
408 */
409 public void setPointInTimeFrom(String pointInTimeFrom1) {
410 this.pointInTimeFrom = pointInTimeFrom1;
411 }
412
413
414 /**
415 * To query members at a certain point in time or time range in the past, set this value
416 * and/or the value of pointInTimeFrom. This parameter specifies the end of the range
417 * of the point in time query. If this is the same as pointInTimeFrom, then the query
418 * will be done at a single point in time rather than a range. If this is specified but
419 * pointInTimeFrom is not specified, then the point in time query range will be from the
420 * minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS
421 * @return the pointInTimeTo
422 */
423 public String getPointInTimeTo() {
424 return this.pointInTimeTo;
425 }
426
427
428 /**
429 * To query members at a certain point in time or time range in the past, set this value
430 * and/or the value of pointInTimeFrom. This parameter specifies the end of the range
431 * of the point in time query. If this is the same as pointInTimeFrom, then the query
432 * will be done at a single point in time rather than a range. If this is specified but
433 * pointInTimeFrom is not specified, then the point in time query range will be from the
434 * minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS
435 * @param pointInTimeTo1 the pointInTimeTo to set
436 */
437 public void setPointInTimeTo(String pointInTimeTo1) {
438 this.pointInTimeTo = pointInTimeTo1;
439 }
440
441 /**
442 * T|F default to F. if this is T then we are doing cursor paging
443 */
444 private String pageIsCursor;
445
446 /**
447 * field that will be sent back for cursor based paging
448 */
449 private String pageLastCursorField;
450
451 /**
452 * could be: string, int, long, date, timestamp
453 */
454 private String pageLastCursorFieldType;
455
456 /**
457 * T|F
458 */
459 private String pageCursorFieldIncludesLastRetrieved;
460
461 /**
462 * @return the pageIsCursor
463 */
464 public String getPageIsCursor() {
465 return pageIsCursor;
466 }
467
468 /**
469 * @param pageIsCursor the pageIsCursor to set
470 */
471 public void setPageIsCursor(String pageIsCursor) {
472 this.pageIsCursor = pageIsCursor;
473 }
474
475 /**
476 * @return the pageLastCursorField
477 */
478 public String getPageLastCursorField() {
479 return pageLastCursorField;
480 }
481
482 /**
483 * @param pageLastCursorField the pageLastCursorField to set
484 */
485 public void setPageLastCursorField(String pageLastCursorField) {
486 this.pageLastCursorField = pageLastCursorField;
487 }
488
489 /**
490 * @return the pageLastCursorFieldType
491 */
492 public String getPageLastCursorFieldType() {
493 return pageLastCursorFieldType;
494 }
495
496 /**
497 * @param pageLastCursorFieldType the pageLastCursorFieldType to set
498 */
499 public void setPageLastCursorFieldType(String pageLastCursorFieldType) {
500 this.pageLastCursorFieldType = pageLastCursorFieldType;
501 }
502
503 /**
504 * @return the pageCursorFieldIncludesLastRetrieved
505 */
506 public String getPageCursorFieldIncludesLastRetrieved() {
507 return pageCursorFieldIncludesLastRetrieved;
508 }
509
510 /**
511 * @param pageCursorFieldIncludesLastRetrieved the pageCursorFieldIncludesLastRetrieved to set
512 */
513 public void setPageCursorFieldIncludesLastRetrieved(String pageCursorFieldIncludesLastRetrieved) {
514 this.pageCursorFieldIncludesLastRetrieved = pageCursorFieldIncludesLastRetrieved;
515 }
516
517 }