Class WsRestGetMembersRequest
java.lang.Object
edu.internet2.middleware.grouperClient.ws.beans.WsRestGetMembersRequest
- All Implemented Interfaces:
WsRequestBean
bean that will be the data from rest request
for method
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionascending T or null for ascending, F for descending.page number 1 indexed if pagingpage 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.sortString must be an hql query field, e.g.String[]
sourceIds, or null if allString[]
void
setActAsSubjectLookup
(WsSubjectLookup actAsSubjectLookup1) void
setAscending
(String ascending1) ascending T or null for ascending, F for descending.void
setClientVersion
(String clientVersion1) void
setFieldName
(String fieldName1) void
setIncludeGroupDetail
(String includeGroupDetail1) void
setIncludeSubjectDetail
(String includeSubjectDetail1) void
setMemberFilter
(String replaceAllExisting1) void
setPageCursorFieldIncludesLastRetrieved
(String pageCursorFieldIncludesLastRetrieved) void
setPageIsCursor
(String pageIsCursor) void
setPageLastCursorField
(String pageLastCursorField) void
setPageLastCursorFieldType
(String pageLastCursorFieldType) void
setPageNumber
(String pageNumber1) page number 1 indexed if pagingvoid
setPageSize
(String pageSize1) 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
setSortString
(String sortString1) sortString must be an hql query field, e.g.void
setSourceIds
(String[] sourceIds1) sourceIds, or null if allvoid
setSubjectAttributeNames
(String[] subjectAttributeNames1) void
setWsGroupLookups
(WsGroupLookup[] wsGroupLookups1)
-
Constructor Details
-
WsRestGetMembersRequest
public WsRestGetMembersRequest()
-
-
Method Details
-
getPageSize
page size if paging- Returns:
- page size
-
setPageSize
page size if paging- Parameters:
pageSize1
-
-
getPageNumber
page number 1 indexed if paging- Returns:
- page number
-
setPageNumber
page number 1 indexed if paging- Parameters:
pageNumber1
-
-
getSortString
sortString must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, name, description, sortString0, sortString1, sortString2, sortString3, sortString4- Returns:
- sort string
-
setSortString
sortString must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, name, description, sortString0, sortString1, sortString2, sortString3, sortString4- Parameters:
sortString1
-
-
getAscending
ascending T or null for ascending, F for descending.- Returns:
- ascending
-
setAscending
ascending T or null for ascending, F for descending.- Parameters:
ascending1
-
-
getSourceIds
sourceIds, or null if all- Returns:
- the sourceIds
-
setSourceIds
sourceIds, or null if all- Parameters:
sourceIds1
- the sourceIds to set
-
getClientVersion
- Returns:
- the clientVersion
-
setClientVersion
- Parameters:
clientVersion1
- the clientVersion to set
-
getWsGroupLookups
- Returns:
- the wsGroupLookups
-
setWsGroupLookups
- Parameters:
wsGroupLookups1
- the wsGroupLookup to set
-
getMemberFilter
- Returns:
- the replaceAllExisting
-
setMemberFilter
- Parameters:
replaceAllExisting1
- the replaceAllExisting to set
-
getActAsSubjectLookup
- Returns:
- the actAsSubjectLookup
-
setActAsSubjectLookup
- Parameters:
actAsSubjectLookup1
- the actAsSubjectLookup to set
-
getFieldName
- Returns:
- the fieldName
-
setFieldName
- 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
-