edu.internet2.middleware.grouper.ws.rest.group.WsRestGetGroupsLiteRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of grouper-ws Show documentation
Show all versions of grouper-ws Show documentation
Internet2 Groups Management WS Core
/*******************************************************************************
* Copyright 2012 Internet2
*
* 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.
******************************************************************************/
/*
* @author mchyzer
* $Id: WsRestGetGroupsLiteRequest.java,v 1.2 2009-12-10 08:54:25 mchyzer Exp $
*/
package edu.internet2.middleware.grouper.ws.rest.group;
import edu.internet2.middleware.grouper.ws.GrouperServiceLogic;
import edu.internet2.middleware.grouper.ws.rest.WsRequestBean;
import edu.internet2.middleware.grouper.ws.rest.method.GrouperRestHttpMethod;
/**
* lite bean that will be the data from rest request
* @see GrouperServiceLogic#getGroupsLite(edu.internet2.middleware.grouper.ws.GrouperWsVersion, String, String, String, edu.internet2.middleware.grouper.ws.member.WsMemberFilter, String, String, String, boolean, boolean, String, String, String, String, String)
* for lite method
*/
public class WsRestGetGroupsLiteRequest implements WsRequestBean {
/**
* field
*/
private String clientVersion;
/** field */
private String subjectId;
/** field */
private String subjectSourceId;
/** field */
private String subjectIdentifier;
/** field */
private String actAsSubjectId;
/** field */
private String actAsSubjectSourceId;
/** field */
private String actAsSubjectIdentifier;
/** field */
private String memberFilter;
/** field */
private String includeGroupDetail;
/** field */
private String includeSubjectDetail;
/** field */
private String subjectAttributeNames;
/** field */
private String paramName0;
/** field */
private String paramValue0;
/** field */
private String paramName1;
/** field */
private String paramValue1;
/** field name (list) to search, blank for members list */
private String fieldName;
/**
* To query members at a certain point in time or time range in the past, set this value
* and/or the value of pointInTimeTo. This parameter specifies the start of the range
* of the point in time query. If this is specified but pointInTimeTo is not specified,
* then the point in time query range will be from the time specified to now.
* Format: yyyy/MM/dd HH:mm:ss.SSS
*/
private String pointInTimeFrom;
/**
* To query members at a certain point in time or time range in the past, set this value
* and/or the value of pointInTimeFrom. This parameter specifies the end of the range
* of the point in time query. If this is the same as pointInTimeFrom, then the query
* will be done at a single point in time rather than a range. If this is specified but
* pointInTimeFrom is not specified, then the point in time query range will be from the
* minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS
*/
private String pointInTimeTo;
/**
* field name (list) to search, blank for members list
* @return field name
*/
public String getFieldName() {
return this.fieldName;
}
/**
* field name (list) to search, blank for members list
* @param fieldName1
*/
public void setFieldName(String fieldName1) {
this.fieldName = fieldName1;
}
/** scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent: */
private String scope;
/** is the stem to check in, or null if all. If has stem, must have stemScope */
private String stemUuid;
/** is the stem to check in, or null if all. If has stem, must have stemScope */
private String stemName;
/** 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 */
private String stemScope;
/** enabled is A for all, T or null for enabled only, F for disabled */
private String enabled;
/** pageSize page size if paging */
private String pageSize;
/** pageNumber page number 1 indexed if paging */
private String pageNumber;
/** sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension */
private String sortString;
/** ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string */
private String ascending;
/**
* T|F default to F. if this is T then we are doing cursor paging
*/
private String pageIsCursor;
/**
* field that will be sent back for cursor based paging
*/
private String pageLastCursorField;
/**
* could be: string, int, long, date, timestamp
*/
private String pageLastCursorFieldType;
/**
* T|F
*/
private String pageCursorFieldIncludesLastRetrieved;
/**
* scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
* @return scope
*/
public String getScope() {
return this.scope;
}
/**
* scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
* @param scope1
*/
public void setScope(String scope1) {
this.scope = scope1;
}
/**
* is the stem to check in, or null if all. If has stem, must have stemScope
* @return stem lookup
*/
public String getStemUuid() {
//TODO return the stem in the response somewhere
return this.stemUuid;
}
/**
* is the stem to check in, or null if all. If has stem, must have stemScope
* @param stemUuid1
*/
public void setStemUuid(String stemUuid1) {
this.stemUuid = stemUuid1;
}
/**
* is the stem to check in, or null if all. If has stem, must have stemScope
* @return stem lookup
*/
public String getStemName() {
return this.stemName;
}
/**
* is the stem to check in, or null if all. If has stem, must have stemScope
* @param stemName1
*/
public void setStemName(String stemName1) {
this.stemName = stemName1;
}
/**
* 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
* @return stem scope
*/
public String getStemScope() {
return this.stemScope;
}
/**
* 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
* @param stemScope1
*/
public void setStemScope(String stemScope1) {
this.stemScope = stemScope1;
}
/**
* enabled is A for all, T or null for enabled only, F for disabled
* @return enabled string
*/
public String getEnabled() {
return this.enabled;
}
/**
* enabled is A for all, T or null for enabled only, F for disabled
* @param enabled1
*/
public void setEnabled(String enabled1) {
this.enabled = enabled1;
}
/**
* pageSize page size if paging
* @return page size
*/
public String getPageSize() {
return this.pageSize;
}
/**
* pageSize page size if paging
* @param pageSize1
*/
public void setPageSize(String pageSize1) {
this.pageSize = pageSize1;
}
/**
* pageNumber page number 1 indexed if paging
* @return page number
*/
public String getPageNumber() {
return this.pageNumber;
}
/**
* pageNumber page number 1 indexed if paging
* @param pageNumber1
*/
public void setPageNumber(String pageNumber1) {
this.pageNumber = pageNumber1;
}
/**
* sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
* @return sort string
*/
public String getSortString() {
return this.sortString;
}
/**
* sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
* @param sortString1
*/
public void setSortString(String sortString1) {
this.sortString = sortString1;
}
/**
* ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string
* @return if ascending
*/
public String getAscending() {
return this.ascending;
}
/**
* ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string
* @param ascending1
*/
public void setAscending(String ascending1) {
this.ascending = ascending1;
}
/**
*
* @return field
*/
public String getClientVersion() {
return this.clientVersion;
}
/**
*
* @param clientVersion1
*/
public void setClientVersion(String clientVersion1) {
this.clientVersion = clientVersion1;
}
/**
*
* @return field
*/
public String getSubjectId() {
return this.subjectId;
}
/**
*
* @param subjectId1
*/
public void setSubjectId(String subjectId1) {
this.subjectId = subjectId1;
}
/**
*
* @return field
*/
public String getSubjectSourceId() {
return this.subjectSourceId;
}
/**
*
* @param subjectSource1
*/
public void setSubjectSourceId(String subjectSource1) {
this.subjectSourceId = subjectSource1;
}
/**
*
* @return field
*/
public String getSubjectIdentifier() {
return this.subjectIdentifier;
}
/**
*
* @param subjectIdentifier1
*/
public void setSubjectIdentifier(String subjectIdentifier1) {
this.subjectIdentifier = subjectIdentifier1;
}
/**
*
* @return field
*/
public String getActAsSubjectId() {
return this.actAsSubjectId;
}
/**
*
* @param actAsSubjectId1
*/
public void setActAsSubjectId(String actAsSubjectId1) {
this.actAsSubjectId = actAsSubjectId1;
}
/**
*
* @return field
*/
public String getActAsSubjectSourceId() {
return this.actAsSubjectSourceId;
}
/**
*
* @param actAsSubjectSource1
*/
public void setActAsSubjectSourceId(String actAsSubjectSource1) {
this.actAsSubjectSourceId = actAsSubjectSource1;
}
/**
*
* @return field
*/
public String getActAsSubjectIdentifier() {
return this.actAsSubjectIdentifier;
}
/**
*
* @param actAsSubjectIdentifier1
*/
public void setActAsSubjectIdentifier(String actAsSubjectIdentifier1) {
this.actAsSubjectIdentifier = actAsSubjectIdentifier1;
}
/**
*
* @return field
*/
public String getMemberFilter() {
return this.memberFilter;
}
/**
*
* @param fieldName1
*/
public void setMemberFilter(String fieldName1) {
this.memberFilter = fieldName1;
}
/**
*
* @return field
*/
public String getIncludeGroupDetail() {
return this.includeGroupDetail;
}
/**
*
* @param includeGroupDetail1
*/
public void setIncludeGroupDetail(String includeGroupDetail1) {
this.includeGroupDetail = includeGroupDetail1;
}
/**
*
* @return field
*/
public String getIncludeSubjectDetail() {
return this.includeSubjectDetail;
}
/**
*
* @param includeSubjectDetail1
*/
public void setIncludeSubjectDetail(String includeSubjectDetail1) {
this.includeSubjectDetail = includeSubjectDetail1;
}
/**
*
* @return field
*/
public String getSubjectAttributeNames() {
return this.subjectAttributeNames;
}
/**
*
* @param subjectAttributeNames1
*/
public void setSubjectAttributeNames(String subjectAttributeNames1) {
this.subjectAttributeNames = subjectAttributeNames1;
}
/**
*
* @return field
*/
public String getParamName0() {
return this.paramName0;
}
/**
*
* @param _paramName0
*/
public void setParamName0(String _paramName0) {
this.paramName0 = _paramName0;
}
/**
*
* @return field
*/
public String getParamValue0() {
return this.paramValue0;
}
/**
*
* @param _paramValue0
*/
public void setParamValue0(String _paramValue0) {
this.paramValue0 = _paramValue0;
}
/**
*
* @return field
*/
public String getParamName1() {
return this.paramName1;
}
/**
*
* @param _paramName1
*/
public void setParamName1(String _paramName1) {
this.paramName1 = _paramName1;
}
/**
*
* @return field
*/
public String getParamValue1() {
return this.paramValue1;
}
/**
*
* @param _paramValue1
*/
public void setParamValue1(String _paramValue1) {
this.paramValue1 = _paramValue1;
}
/**
* @see edu.internet2.middleware.grouper.ws.rest.WsRequestBean#retrieveRestHttpMethod()
*/
@Override
public GrouperRestHttpMethod retrieveRestHttpMethod() {
return GrouperRestHttpMethod.GET;
}
/**
* To query members at a certain point in time or time range in the past, set this value
* and/or the value of pointInTimeTo. This parameter specifies the start of the range
* of the point in time query. If this is specified but pointInTimeTo is not specified,
* then the point in time query range will be from the time specified to now.
* Format: yyyy/MM/dd HH:mm:ss.SSS
* @return the pointInTimeFrom
*/
public String getPointInTimeFrom() {
return this.pointInTimeFrom;
}
/**
* To query members at a certain point in time or time range in the past, set this value
* and/or the value of pointInTimeTo. This parameter specifies the start of the range
* of the point in time query. If this is specified but pointInTimeTo is not specified,
* then the point in time query range will be from the time specified to now.
* Format: yyyy/MM/dd HH:mm:ss.SSS
* @param pointInTimeFrom1 the pointInTimeFrom to set
*/
public void setPointInTimeFrom(String pointInTimeFrom1) {
this.pointInTimeFrom = pointInTimeFrom1;
}
/**
* To query members at a certain point in time or time range in the past, set this value
* and/or the value of pointInTimeFrom. This parameter specifies the end of the range
* of the point in time query. If this is the same as pointInTimeFrom, then the query
* will be done at a single point in time rather than a range. If this is specified but
* pointInTimeFrom is not specified, then the point in time query range will be from the
* minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS
* @return the pointInTimeTo
*/
public String getPointInTimeTo() {
return this.pointInTimeTo;
}
/**
* To query members at a certain point in time or time range in the past, set this value
* and/or the value of pointInTimeFrom. This parameter specifies the end of the range
* of the point in time query. If this is the same as pointInTimeFrom, then the query
* will be done at a single point in time rather than a range. If this is specified but
* pointInTimeFrom is not specified, then the point in time query range will be from the
* minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS
* @param pointInTimeTo1 the pointInTimeTo to set
*/
public void setPointInTimeTo(String pointInTimeTo1) {
this.pointInTimeTo = pointInTimeTo1;
}
/**
* @return the pageIsCursor
*/
public String getPageIsCursor() {
return this.pageIsCursor;
}
/**
* @param pageIsCursor1 the pageIsCursor to set
*/
public void setPageIsCursor(String pageIsCursor1) {
this.pageIsCursor = pageIsCursor1;
}
/**
* @return the pageLastCursorField
*/
public String getPageLastCursorField() {
return this.pageLastCursorField;
}
/**
* @param pageLastCursorField1 the pageLastCursorField to set
*/
public void setPageLastCursorField(String pageLastCursorField1) {
this.pageLastCursorField = pageLastCursorField1;
}
/**
* @return the pageLastCursorFieldType
*/
public String getPageLastCursorFieldType() {
return this.pageLastCursorFieldType;
}
/**
* @param pageLastCursorFieldType1 the pageLastCursorFieldType to set
*/
public void setPageLastCursorFieldType(String pageLastCursorFieldType1) {
this.pageLastCursorFieldType = pageLastCursorFieldType1;
}
/**
* @return the pageCursorFieldIncludesLastRetrieved
*/
public String getPageCursorFieldIncludesLastRetrieved() {
return this.pageCursorFieldIncludesLastRetrieved;
}
/**
* @param pageCursorFieldIncludesLastRetrieved1 the pageCursorFieldIncludesLastRetrieved to set
*/
public void setPageCursorFieldIncludesLastRetrieved(String pageCursorFieldIncludesLastRetrieved1) {
this.pageCursorFieldIncludesLastRetrieved = pageCursorFieldIncludesLastRetrieved1;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy