Class WsRestGetGroupsRequest
java.lang.Object
edu.internet2.middleware.grouperClient.ws.beans.WsRestGetGroupsRequest
- All Implemented Interfaces:
WsRequestBean
bean that will be the data from rest request
for method
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionascending or null for ascending, F for descending.enabled is A for all, T or null for enabled only, F for disabledfield name (list) to search, blank for members listpageNumber page number 1 indexed if pagingpageSize page size if pagingWsParam[]
To query members at a certain point in time or time range in the past, set this value and/or the value of 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.getScope()
scope is a DB pattern that will have % appended to it, or null for all.sortString must be an hql query field, e.g.stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.String[]
is the stem to check in, or null if all.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 disabledvoid
setFieldName
(String fieldName1) field name (list) to search, blank for members listvoid
setIncludeGroupDetail
(String includeGroupDetail1) void
setIncludeSubjectDetail
(String includeSubjectDetail1) void
setMemberFilter
(String fieldName1) void
setPageCursorFieldIncludesLastRetrieved
(String pageCursorFieldIncludesLastRetrieved) void
setPageIsCursor
(String pageIsCursor) void
setPageLastCursorField
(String pageLastCursorField) void
setPageLastCursorFieldType
(String pageLastCursorFieldType) void
setPageNumber
(String pageNumber1) pageNumber page number 1 indexed if pagingvoid
setPageSize
(String pageSize1) pageSize page size if pagingvoid
void
setPointInTimeFrom
(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
(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
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.
-
Constructor Details
-
WsRestGetGroupsRequest
public WsRestGetGroupsRequest()
-
-
Method Details
-
getFieldName
field name (list) to search, blank for members list- Returns:
- field name
-
setFieldName
field name (list) to search, blank for members list- Parameters:
fieldName1
-
-
getScope
scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:- Returns:
- scope
-
setScope
scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:- Parameters:
scope1
-
-
getWsStemLookup
is the stem to check in, or null if all. If has stem, must have stemScope- Returns:
- stem lookup
-
setWsStemLookup
is the stem to check in, or null if all. If has stem, must have stemScope- Parameters:
wsStemLookup1
-
-
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
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
enabled is A for all, T or null for enabled only, F for disabled- Returns:
- enabled string
-
setEnabled
enabled is A for all, T or null for enabled only, F for disabled- Parameters:
enabled1
-
-
getPageSize
pageSize page size if paging- Returns:
- page size
-
setPageSize
pageSize page size if paging- Parameters:
pageSize1
-
-
getPageNumber
pageNumber page number 1 indexed if paging- Returns:
- page number
-
setPageNumber
pageNumber page number 1 indexed if paging- Parameters:
pageNumber1
-
-
getSortString
sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Returns:
- sort string
-
setSortString
sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Parameters:
sortString1
-
-
getAscending
ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string- Returns:
- if ascending
-
setAscending
ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string- Parameters:
ascending1
-
-
getClientVersion
- Returns:
- the clientVersion
-
setClientVersion
- Parameters:
clientVersion1
- the clientVersion to set
-
getSubjectLookups
- Returns:
- the subjectLookups
-
setSubjectLookups
- Parameters:
subjectLookups1
- the subjectLookups to set
-
getActAsSubjectLookup
- Returns:
- the actAsSubjectLookup
-
setActAsSubjectLookup
- Parameters:
actAsSubjectLookup1
- the actAsSubjectLookup to set
-
getMemberFilter
- Returns:
- the fieldName
-
setMemberFilter
- Parameters:
fieldName1
- the fieldName to set
-
getIncludeGroupDetail
- Returns:
- the includeGroupDetail
-
setIncludeGroupDetail
- Parameters:
includeGroupDetail1
- the includeGroupDetail to set
-
getIncludeSubjectDetail
- Returns:
- the includeSubjectDetail
-
setIncludeSubjectDetail
- Parameters:
includeSubjectDetail1
- the includeSubjectDetail to set
-
getSubjectAttributeNames
- Returns:
- the subjectAttributeNames
-
setSubjectAttributeNames
- Parameters:
subjectAttributeNames1
- the subjectAttributeNames to set
-
getParams
- Returns:
- the params
-
setParams
- Parameters:
params1
- the params to set
-
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
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
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
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
-
getPageIsCursor
- Returns:
- the pageIsCursor
-
setPageIsCursor
- Parameters:
pageIsCursor
- the pageIsCursor to set
-
getPageLastCursorField
- Returns:
- the pageLastCursorField
-
setPageLastCursorField
- Parameters:
pageLastCursorField
- the pageLastCursorField to set
-
getPageLastCursorFieldType
- Returns:
- the pageLastCursorFieldType
-
setPageLastCursorFieldType
- Parameters:
pageLastCursorFieldType
- the pageLastCursorFieldType to set
-
getPageCursorFieldIncludesLastRetrieved
- Returns:
- the pageCursorFieldIncludesLastRetrieved
-
setPageCursorFieldIncludesLastRetrieved
- Parameters:
pageCursorFieldIncludesLastRetrieved
- the pageCursorFieldIncludesLastRetrieved to set
-