edu.internet2.middleware.grouper.ws.rest.group
Class WsRestGetGroupsRequest

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.rest.group.WsRestGetGroupsRequest
All Implemented Interfaces:
WsRequestBean

public class WsRestGetGroupsRequest
extends Object
implements WsRequestBean

bean that will be the data from rest request

See Also:
for method

Constructor Summary
WsRestGetGroupsRequest()
           
 
Method Summary
 WsSubjectLookup getActAsSubjectLookup()
           
 String getAscending()
          ascending or null for ascending, F for descending.
 String getClientVersion()
           
 String getEnabled()
          enabled is A for all, T or null for enabled only, F for disabled
 String getFieldName()
          field name (list) to search, blank for members list
 String getIncludeGroupDetail()
           
 String getIncludeSubjectDetail()
           
 String getMemberFilter()
           
 String getPageNumber()
          pageNumber page number 1 indexed if paging
 String getPageSize()
          pageSize page size if paging
 WsParam[] getParams()
           
 String getScope()
          scope is a DB pattern that will have % appended to it, or null for all.
 String getSortString()
          sortString must be an hql query field, e.g.
 String getStemScope()
          stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
 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(String ascending1)
          ascending or null for ascending, F for descending.
 void setClientVersion(String clientVersion1)
           
 void setEnabled(String enabled1)
          enabled is A for all, T or null for enabled only, F for disabled
 void setFieldName(String fieldName1)
          field name (list) to search, blank for members list
 void setIncludeGroupDetail(String includeGroupDetail1)
           
 void setIncludeSubjectDetail(String includeSubjectDetail1)
           
 void setMemberFilter(String fieldName1)
           
 void setPageNumber(String pageNumber1)
          pageNumber page number 1 indexed if paging
 void setPageSize(String pageSize1)
          pageSize page size if paging
 void setParams(WsParam[] params1)
           
 void setScope(String scope1)
          scope is a DB pattern that will have % appended to it, or null for all.
 void setSortString(String sortString1)
          sortString must be an hql query field, e.g.
 void setStemScope(String stemScope1)
          stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
 void setSubjectAttributeNames(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 String getFieldName()
field name (list) to search, blank for members list

Returns:
field name

setFieldName

public void setFieldName(String fieldName1)
field name (list) to search, blank for members list

Parameters:
fieldName1 -

getScope

public 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(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 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(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 String getEnabled()
enabled is A for all, T or null for enabled only, F for disabled

Returns:
enabled string

setEnabled

public void setEnabled(String enabled1)
enabled is A for all, T or null for enabled only, F for disabled

Parameters:
enabled1 -

getPageSize

public String getPageSize()
pageSize page size if paging

Returns:
page size

setPageSize

public void setPageSize(String pageSize1)
pageSize page size if paging

Parameters:
pageSize1 -

getPageNumber

public String getPageNumber()
pageNumber page number 1 indexed if paging

Returns:
page number

setPageNumber

public void setPageNumber(String pageNumber1)
pageNumber page number 1 indexed if paging

Parameters:
pageNumber1 -

getSortString

public 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(String sortString1)
sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension

Parameters:
sortString1 -

getAscending

public 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(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 String getClientVersion()
Returns:
the clientVersion

setClientVersion

public void setClientVersion(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 String getMemberFilter()
Returns:
the fieldName

setMemberFilter

public void setMemberFilter(String fieldName1)
Parameters:
fieldName1 - the fieldName to set

getIncludeGroupDetail

public String getIncludeGroupDetail()
Returns:
the includeGroupDetail

setIncludeGroupDetail

public void setIncludeGroupDetail(String includeGroupDetail1)
Parameters:
includeGroupDetail1 - the includeGroupDetail to set

getIncludeSubjectDetail

public String getIncludeSubjectDetail()
Returns:
the includeSubjectDetail

setIncludeSubjectDetail

public void setIncludeSubjectDetail(String includeSubjectDetail1)
Parameters:
includeSubjectDetail1 - the includeSubjectDetail to set

getSubjectAttributeNames

public String[] getSubjectAttributeNames()
Returns:
the subjectAttributeNames

setSubjectAttributeNames

public void setSubjectAttributeNames(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()