Class WsRestGetMembersLiteRequest
java.lang.Object
edu.internet2.middleware.grouper.ws.rest.member.WsRestGetMembersLiteRequest
- All Implemented Interfaces:
WsRequestBean
request bean for rest get members request
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionactAsSubjectIdactAsSubjectIdentifieractAsSubjectSourceascending T or null for ascending, F for descending.fieldNameincludeGroupDetailpage number 1 indexed if pagingpage size if pagingparamName0paramName1paramValue0paramValue1To 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.retrieveSubjectDetailsortString must be an hql query field, e.g.sourceids to limit request to, or null for allsubjectAttributeNamessee which http method this is supposed to be associated with, and override whatever was passed invoidsetActAsSubjectId(String actAsSubjectId1) actAsSubjectIdvoidsetActAsSubjectIdentifier(String actAsSubjectIdentifier1) actAsSubjectIdentifiervoidsetActAsSubjectSourceId(String actAsSubjectSource1) actAsSubjectSourcevoidsetAscending(String ascending1) ascending T or null for ascending, F for descending.voidsetClientVersion(String clientVersion1) voidsetFieldName(String fieldName1) fieldNamevoidsetGroupName(String groupName1) voidsetGroupUuid(String groupUuid1) voidsetIncludeGroupDetail(String includeGroupDetail1) includeGroupDetailvoidsetMemberFilter(String memberFilter1) memberFilter1voidsetPageCursorFieldIncludesLastRetrieved(String pageCursorFieldIncludesLastRetrieved1) voidsetPageIsCursor(String pageIsCursor1) voidsetPageLastCursorField(String pageLastCursorField1) voidsetPageLastCursorFieldType(String pageLastCursorFieldType1) voidsetPageNumber(String pageNumber1) page number 1 indexed if pagingvoidsetPageSize(String pageSize1) page size if pagingvoidsetParamName0(String _paramName0) paramName0voidsetParamName1(String _paramName1) paramName1voidsetParamValue0(String _paramValue0) _paramValue0voidsetParamValue1(String _paramValue1) paramValue1voidsetPointInTimeFrom(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.voidsetPointInTimeRetrieve(String pointInTimeRetrieve1) voidsetPointInTimeTo(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.voidsetRetrieveSubjectDetail(String retrieveSubjectDetail1) retrieveSubjectDetail1voidsetSortString(String sortString1) sortString must be an hql query field, e.g.voidsetSourceIds(String sourceIds1) sourceids to limit request to, or null for allvoidsetSubjectAttributeNames(String subjectAttributeNames1) subjectAttributeNames
-
Constructor Details
-
WsRestGetMembersLiteRequest
public WsRestGetMembersLiteRequest()
-
-
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 to limit request to, or null for all- Returns:
- the sourceIds
-
setSourceIds
sourceids to limit request to, or null for all- Parameters:
sourceIds1- the sourceIds to set
-
getMemberFilter
- Returns:
- member filter
-
setMemberFilter
memberFilter1- Parameters:
memberFilter1-
-
getRetrieveSubjectDetail
retrieveSubjectDetail- Returns:
- retrieveSubjectDetail
-
setRetrieveSubjectDetail
retrieveSubjectDetail1- Parameters:
retrieveSubjectDetail1-
-
getActAsSubjectId
actAsSubjectId- Returns:
- actAsSubjectId
-
setActAsSubjectId
actAsSubjectId- Parameters:
actAsSubjectId1-
-
getActAsSubjectSourceId
actAsSubjectSource- Returns:
- actAsSubjectSource
-
setActAsSubjectSourceId
actAsSubjectSource- Parameters:
actAsSubjectSource1-
-
getActAsSubjectIdentifier
actAsSubjectIdentifier- Returns:
- actAsSubjectIdentifier
-
setActAsSubjectIdentifier
actAsSubjectIdentifier- Parameters:
actAsSubjectIdentifier1-
-
getFieldName
fieldName- Returns:
- fieldName
-
setFieldName
fieldName- Parameters:
fieldName1-
-
getSubjectAttributeNames
subjectAttributeNames- Returns:
- subjectAttributeNames
-
setSubjectAttributeNames
subjectAttributeNames- Parameters:
subjectAttributeNames1-
-
getIncludeGroupDetail
includeGroupDetail- Returns:
- includeGroupDetail
-
setIncludeGroupDetail
includeGroupDetail- Parameters:
includeGroupDetail1-
-
getParamName0
paramName0- Returns:
- paramName0
-
setParamName0
paramName0- Parameters:
_paramName0-
-
getParamValue0
paramValue0- Returns:
- paramValue0
-
setParamValue0
_paramValue0- Parameters:
_paramValue0-
-
getParamName1
paramName1- Returns:
- paramName1
-
setParamName1
paramName1- Parameters:
_paramName1-
-
getParamValue1
paramValue1- Returns:
- paramValue1
-
setParamValue1
paramValue1- Parameters:
_paramValue1-
-
getGroupName
- Returns:
- the groupName
-
setGroupName
- Parameters:
groupName1- the groupName to set
-
getGroupUuid
- Returns:
- the groupUuid
-
setGroupUuid
- Parameters:
groupUuid1- the groupUuid to set
-
getClientVersion
- Returns:
- the clientVersion
-
setClientVersion
- Parameters:
clientVersion1- the clientVersion to set
-
retrieveRestHttpMethod
Description copied from interface:WsRequestBeansee which http method this is supposed to be associated with, and override whatever was passed in- Specified by:
retrieveRestHttpMethodin interfaceWsRequestBean- Returns:
- the method
- See Also:
-
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:
pageIsCursor1- the pageIsCursor to set
-
getPageLastCursorField
- Returns:
- the pageLastCursorField
-
setPageLastCursorField
- Parameters:
pageLastCursorField1- the pageLastCursorField to set
-
getPageLastCursorFieldType
- Returns:
- the pageLastCursorFieldType
-
setPageLastCursorFieldType
- Parameters:
pageLastCursorFieldType1- the pageLastCursorFieldType to set
-
getPageCursorFieldIncludesLastRetrieved
- Returns:
- the pageCursorFieldIncludesLastRetrieved
-
setPageCursorFieldIncludesLastRetrieved
- Parameters:
pageCursorFieldIncludesLastRetrieved1- the pageCursorFieldIncludesLastRetrieved to set
-
getPointInTimeRetrieve
- Returns:
- the pointInTimeRetrieve
-
setPointInTimeRetrieve
- Parameters:
pointInTimeRetrieve1- the pointInTimeRetrieve to set
-