WsRestGetGroupsRequest

java.lang.Object
- edu.internet2.middleware.grouper.ws.rest.group.WsRestGetGroupsRequest

All Implemented Interfaces:

WsRequestBean
```
public class WsRestGetGroupsRequest
extends java.lang.Object
implements WsRequestBean
```
bean that will be the data from rest request

See Also:

for method

Constructor Summary

Constructors
Constructor and Description

WsRestGetGroupsRequest()

Constructors
Constructor and Description
`WsRestGetGroupsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WsSubjectLookup`	`getActAsSubjectLookup()`
`java.lang.String`	`getAscending()` ascending or null for ascending, F for descending.
`java.lang.String`	`getClientVersion()`
`java.lang.String`	`getEnabled()` enabled is A for all, T or null for enabled only, F for disabled
`java.lang.String`	`getFieldName()` field name (list) to search, blank for members list
`java.lang.String`	`getIncludeGroupDetail()`
`java.lang.String`	`getIncludeSubjectDetail()`
`java.lang.String`	`getMemberFilter()`
`java.lang.String`	`getPageNumber()` pageNumber page number 1 indexed if paging
`java.lang.String`	`getPageSize()` pageSize page size if paging
`WsParam[]`	`getParams()`
`java.lang.String`	`getPointInTimeFrom()` To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo.
`java.lang.String`	`getPointInTimeTo()` To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom.
`java.lang.String`	`getScope()` scope is a DB pattern that will have % appended to it, or null for all.
`java.lang.String`	`getSortString()` sortString must be an hql query field, e.g.
`java.lang.String`	`getStemScope()` stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
`java.lang.String[]`	`getSubjectAttributeNames()`
`WsSubjectLookup[]`	`getSubjectLookups()`
`WsStemLookup`	`getWsStemLookup()` is the stem to check in, or null if all.
`GrouperRestHttpMethod`	`retrieveRestHttpMethod()` see which http method this is supposed to be associated with, and override whatever was passed in
`void`	`setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)`
`void`	`setAscending(java.lang.String ascending1)` ascending or null for ascending, F for descending.
`void`	`setClientVersion(java.lang.String clientVersion1)`
`void`	`setEnabled(java.lang.String enabled1)` enabled is A for all, T or null for enabled only, F for disabled
`void`	`setFieldName(java.lang.String fieldName1)` field name (list) to search, blank for members list
`void`	`setIncludeGroupDetail(java.lang.String includeGroupDetail1)`
`void`	`setIncludeSubjectDetail(java.lang.String includeSubjectDetail1)`
`void`	`setMemberFilter(java.lang.String fieldName1)`
`void`	`setPageNumber(java.lang.String pageNumber1)` pageNumber page number 1 indexed if paging
`void`	`setPageSize(java.lang.String pageSize1)` pageSize page size if paging
`void`	`setParams(WsParam[] params1)`
`void`	`setPointInTimeFrom(java.lang.String pointInTimeFrom1)` To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo.
`void`	`setPointInTimeTo(java.lang.String pointInTimeTo1)` To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom.
`void`	`setScope(java.lang.String scope1)` scope is a DB pattern that will have % appended to it, or null for all.
`void`	`setSortString(java.lang.String sortString1)` sortString must be an hql query field, e.g.
`void`	`setStemScope(java.lang.String stemScope1)` stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
`void`	`setSubjectAttributeNames(java.lang.String[] subjectAttributeNames1)`
`void`	`setSubjectLookups(WsSubjectLookup[] subjectLookups1)`
`void`	`setWsStemLookup(WsStemLookup wsStemLookup1)` is the stem to check in, or null if all.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WsRestGetGroupsRequest
```
public WsRestGetGroupsRequest()
```
- Method Detail
  - getFieldName
```
public java.lang.String getFieldName()
```
    field name (list) to search, blank for members list
    
    Returns:
    
    field name
  - setFieldName
```
public void setFieldName(java.lang.String fieldName1)
```
    field name (list) to search, blank for members list
    
    Parameters:
    
    fieldName1 -
  - getScope
```
public java.lang.String getScope()
```
    scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
    
    Returns:
    
    scope
  - setScope
```
public void setScope(java.lang.String scope1)
```
    scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
    
    Parameters:
    
    scope1 -
  - getWsStemLookup
```
public WsStemLookup getWsStemLookup()
```
    is the stem to check in, or null if all. If has stem, must have stemScope
    
    Returns:
    
    stem lookup
  - setWsStemLookup
```
public void setWsStemLookup(WsStemLookup wsStemLookup1)
```
    is the stem to check in, or null if all. If has stem, must have stemScope
    
    Parameters:
    
    wsStemLookup1 -
  - getStemScope
```
public java.lang.String getStemScope()
```
    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
    
    Returns:
    
    stem scope
  - setStemScope
```
public void setStemScope(java.lang.String stemScope1)
```
    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
    
    Parameters:
    
    stemScope1 -
  - getEnabled
```
public java.lang.String getEnabled()
```
    enabled is A for all, T or null for enabled only, F for disabled
    
    Returns:
    
    enabled string
  - setEnabled
```
public void setEnabled(java.lang.String enabled1)
```
    enabled is A for all, T or null for enabled only, F for disabled
    
    Parameters:
    
    enabled1 -
  - getPageSize
```
public java.lang.String getPageSize()
```
    pageSize page size if paging
    
    Returns:
    
    page size
  - setPageSize
```
public void setPageSize(java.lang.String pageSize1)
```
    pageSize page size if paging
    
    Parameters:
    
    pageSize1 -
  - getPageNumber
```
public java.lang.String getPageNumber()
```
    pageNumber page number 1 indexed if paging
    
    Returns:
    
    page number
  - setPageNumber
```
public void setPageNumber(java.lang.String pageNumber1)
```
    pageNumber page number 1 indexed if paging
    
    Parameters:
    
    pageNumber1 -
  - getSortString
```
public java.lang.String getSortString()
```
    sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
    
    Returns:
    
    sort string
  - setSortString
```
public void setSortString(java.lang.String sortString1)
```
    sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
    
    Parameters:
    
    sortString1 -
  - getAscending
```
public java.lang.String getAscending()
```
    ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string
    
    Returns:
    
    if ascending
  - setAscending
```
public void setAscending(java.lang.String ascending1)
```
    ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string
    
    Parameters:
    
    ascending1 -
  - getClientVersion
```
public java.lang.String getClientVersion()
```
    Returns:
    
    the clientVersion
  - setClientVersion
```
public void setClientVersion(java.lang.String clientVersion1)
```
    Parameters:
    
    clientVersion1 - the clientVersion to set
  - getSubjectLookups
```
public WsSubjectLookup[] getSubjectLookups()
```
    Returns:
    
    the subjectLookups
  - setSubjectLookups
```
public void setSubjectLookups(WsSubjectLookup[] subjectLookups1)
```
    Parameters:
    
    subjectLookups1 - the subjectLookups to set
  - getActAsSubjectLookup
```
public WsSubjectLookup getActAsSubjectLookup()
```
    Returns:
    
    the actAsSubjectLookup
  - setActAsSubjectLookup
```
public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
```
    Parameters:
    
    actAsSubjectLookup1 - the actAsSubjectLookup to set
  - getMemberFilter
```
public java.lang.String getMemberFilter()
```
    Returns:
    
    the fieldName
  - setMemberFilter
```
public void setMemberFilter(java.lang.String fieldName1)
```
    Parameters:
    
    fieldName1 - the fieldName to set
  - getIncludeGroupDetail
```
public java.lang.String getIncludeGroupDetail()
```
    Returns:
    
    the includeGroupDetail
  - setIncludeGroupDetail
```
public void setIncludeGroupDetail(java.lang.String includeGroupDetail1)
```
    Parameters:
    
    includeGroupDetail1 - the includeGroupDetail to set
  - getIncludeSubjectDetail
```
public java.lang.String getIncludeSubjectDetail()
```
    Returns:
    
    the includeSubjectDetail
  - setIncludeSubjectDetail
```
public void setIncludeSubjectDetail(java.lang.String includeSubjectDetail1)
```
    Parameters:
    
    includeSubjectDetail1 - the includeSubjectDetail to set
  - getSubjectAttributeNames
```
public java.lang.String[] getSubjectAttributeNames()
```
    Returns:
    
    the subjectAttributeNames
  - setSubjectAttributeNames
```
public void setSubjectAttributeNames(java.lang.String[] subjectAttributeNames1)
```
    Parameters:
    
    subjectAttributeNames1 - the subjectAttributeNames to set
  - getParams
```
public WsParam[] getParams()
```
    Returns:
    
    the params
  - setParams
```
public void setParams(WsParam[] params1)
```
    Parameters:
    
    params1 - the params to set
  - retrieveRestHttpMethod
```
public GrouperRestHttpMethod retrieveRestHttpMethod()
```
    Description copied from interface: WsRequestBean
    
    see which http method this is supposed to be associated with, and override whatever was passed in
    
    Specified by:
    
    retrieveRestHttpMethod in interface WsRequestBean
    
    Returns:
    
    the method
    
    See Also:
    
    WsRequestBean.retrieveRestHttpMethod()
  - getPointInTimeFrom
```
public java.lang.String getPointInTimeFrom()
```
    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
    
    Returns:
    
    the pointInTimeFrom
  - setPointInTimeFrom
```
public void setPointInTimeFrom(java.lang.String pointInTimeFrom1)
```
    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
    
    Parameters:
    
    pointInTimeFrom1 - the pointInTimeFrom to set
  - getPointInTimeTo
```
public java.lang.String getPointInTimeTo()
```
    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
    
    Returns:
    
    the pointInTimeTo
  - setPointInTimeTo
```
public void setPointInTimeTo(java.lang.String pointInTimeTo1)
```
    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
    
    Parameters:
    
    pointInTimeTo1 - the pointInTimeTo to set

Class WsRestGetGroupsRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WsRestGetGroupsRequest

Method Detail

getFieldName

setFieldName

getScope

setScope

getWsStemLookup

setWsStemLookup

getStemScope

setStemScope

getEnabled

setEnabled

getPageSize

setPageSize

getPageNumber

setPageNumber

getSortString

setSortString

getAscending

setAscending

getClientVersion

setClientVersion

getSubjectLookups

setSubjectLookups

getActAsSubjectLookup

setActAsSubjectLookup

getMemberFilter

setMemberFilter

getIncludeGroupDetail

setIncludeGroupDetail

getIncludeSubjectDetail

setIncludeSubjectDetail

getSubjectAttributeNames

setSubjectAttributeNames

getParams

setParams

retrieveRestHttpMethod

getPointInTimeFrom

setPointInTimeFrom

getPointInTimeTo

setPointInTimeTo