public class WsRestGetMembershipsRequest extends Object implements WsRequestBean
Constructor and Description |
---|
WsRestGetMembershipsRequest() |
Modifier and Type | Method and Description |
---|---|
WsSubjectLookup |
getActAsSubjectLookup()
subject to act as instead of logged in user
|
String |
getAscending()
ascending T or null for ascending, F for descending.
|
String |
getAscendingForMember()
T or null for ascending, F for descending in the members part
|
String |
getClientVersion()
is the version of the client.
|
String |
getEnabled()
enabled is A for all, T or null for enabled only, F for disabled
|
String |
getFieldName()
is if the memberships should be retrieved from a certain field membership
of the group (certain list)
|
String |
getFieldType()
fieldType is the type of field to look at, e.g.
|
String |
getIncludeGroupDetail()
T or F as to if the group detail should be returned
|
String |
getIncludeSubjectDetail()
T|F, for if the extended subject information should be
returned (anything more than just the id)
|
String |
getMemberFilter()
must be one of All, Effective, Immediate, Composite, NonImmediate
|
String[] |
getMembershipIds()
membershipIds are the ids to search for if they are known
|
String |
getPageCursorFieldIncludesLastRetrieved() |
String |
getPageCursorFieldIncludesLastRetrievedForMember() |
String |
getPageIsCursor() |
String |
getPageIsCursorForMember() |
String |
getPageLastCursorField() |
String |
getPageLastCursorFieldForMember() |
String |
getPageLastCursorFieldType() |
String |
getPageLastCursorFieldTypeForMember() |
String |
getPageNumber()
page number 1 indexed if paging
|
String |
getPageNumberForMember()
page number 1 indexed if paging in the members part
|
String |
getPageSize()
page size if paging
|
String |
getPageSizeForMember()
page size if paging in the members part
|
WsParam[] |
getParams()
optional: reserved for future use
|
String |
getPointInTimeFrom() |
String |
getPointInTimeRetrieve() |
String |
getPointInTimeTo() |
String |
getScope()
scope is a sql like string which will have a percent % concatenated to the end for group
names to search in (or stem names)
|
WsAttributeDefNameLookup |
getServiceLookup()
serviceLookup if filtering by users in a service, then this is the service to look in
|
String |
getServiceRole()
serviceRole to filter attributes that a user has a certain role
|
String |
getSortString()
sortString must be an hql query field, e.g.
|
String |
getSortStringForMember()
must be an hql query field, e.g.
|
String[] |
getSourceIds()
sourceIds are sources to look in for memberships, or null if all
|
String |
getStemScope()
stemScope is StemScope to search only in one stem or in substems: ONE_LEVEL, ALL_IN_SUBTREE
|
String[] |
getSubjectAttributeNames()
are the additional subject attributes (data) to return.
|
WsGroupLookup[] |
getWsGroupLookups()
are groups to look in
|
WsAttributeDefLookup[] |
getWsOwnerAttributeDefLookups()
attribute definition lookups if looking for memberships on certain attribute definitions
|
WsStemLookup[] |
getWsOwnerStemLookups()
stem lookups if looking for memberships on certain stems
|
WsStemLookup |
getWsStemLookup()
wsStemLookup is the stem to look in for memberships
|
WsSubjectLookup[] |
getWsSubjectLookups()
are subjects to look in
|
void |
setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
subject to act as instead of logged in user
|
void |
setAscending(String ascending1)
ascending T or null for ascending, F for descending.
|
void |
setAscendingForMember(String ascendingForMember1)
T or null for ascending, F for descending in the members part
|
void |
setClientVersion(String clientVersion1)
is the version of the client.
|
void |
setEnabled(String enabled1)
enabled is A for all, T or null for enabled only, F for disabled
|
void |
setFieldName(String fieldName1)
is if the memberships should be retrieved from a certain field membership
of the group (certain list)
|
void |
setFieldType(String fieldType1)
fieldType is the type of field to look at, e.g.
|
void |
setIncludeGroupDetail(String includeGroupDetail1)
T or F as to if the group detail should be returned
|
void |
setIncludeSubjectDetail(String includeSubjectDetail1)
T|F, for if the extended subject information should be
returned (anything more than just the id)
|
void |
setMemberFilter(String replaceAllExisting1)
must be one of All, Effective, Immediate, Composite, NonImmediate
|
void |
setMembershipIds(String[] membershipsIds1)
membershipIds are the ids to search for if they are known
|
void |
setPageCursorFieldIncludesLastRetrieved(String pageCursorFieldIncludesLastRetrieved) |
void |
setPageCursorFieldIncludesLastRetrievedForMember(String pageCursorFieldIncludesLastRetrievedForMember) |
void |
setPageIsCursor(String pageIsCursor) |
void |
setPageIsCursorForMember(String pageIsCursorForMember) |
void |
setPageLastCursorField(String pageLastCursorField) |
void |
setPageLastCursorFieldForMember(String pageLastCursorFieldForMember) |
void |
setPageLastCursorFieldType(String pageLastCursorFieldType) |
void |
setPageLastCursorFieldTypeForMember(String pageLastCursorFieldTypeForMember) |
void |
setPageNumber(String pageNumber1)
page number 1 indexed if paging
|
void |
setPageNumberForMember(String pageNumberForMember1)
page number 1 indexed if paging in the members part
|
void |
setPageSize(String pageSize1)
page size if paging
|
void |
setPageSizeForMember(String pageSizeForMember1)
page size if paging in the members part
|
void |
setParams(WsParam[] params1)
optional: reserved for future use
|
void |
setPointInTimeFrom(String pointInTimeFrom) |
void |
setPointInTimeRetrieve(String pointInTimeRetrieve) |
void |
setPointInTimeTo(String pointInTimeTo) |
void |
setScope(String scope1)
scope is a sql like string which will have a percent % concatenated to the end for group
names to search in (or stem names)
|
void |
setServiceLookup(WsAttributeDefNameLookup serviceLookup1)
serviceLookup if filtering by users in a service, then this is the service to look in
|
void |
setServiceRole(String serviceRole1)
serviceRole to filter attributes that a user has a certain role
|
void |
setSortString(String sortString1)
sortString must be an hql query field, e.g.
|
void |
setSortStringForMember(String sortStringForMember1) |
void |
setSourceIds(String[] sourceIds1)
sourceIds are sources to look in for memberships, or null if all
|
void |
setStemScope(String stemScope1)
stemScope is StemScope to search only in one stem or in substems: ONE_LEVEL, ALL_IN_SUBTREE
|
void |
setSubjectAttributeNames(String[] subjectAttributeNames1)
are the additional subject attributes (data) to return.
|
void |
setWsGroupLookups(WsGroupLookup[] wsGroupLookups1)
are groups to look in
|
void |
setWsOwnerAttributeDefLookups(WsAttributeDefLookup[] wsAttributeDefLookups1)
attribute definition lookups if looking for memberships on certain attribute definitions
|
void |
setWsOwnerStemLookups(WsStemLookup[] wsStemLookups1)
stem lookups if looking for memberships on certain stems
|
void |
setWsStemLookup(WsStemLookup wsStemLookup1)
wsStemLookup is the stem to look in for memberships
|
void |
setWsSubjectLookups(WsSubjectLookup[] wsSubjectLookups1)
are subjects to look in
|
public WsStemLookup[] getWsOwnerStemLookups()
public void setWsOwnerStemLookups(WsStemLookup[] wsStemLookups1)
wsStemLookups1
- public WsAttributeDefLookup[] getWsOwnerAttributeDefLookups()
public void setWsOwnerAttributeDefLookups(WsAttributeDefLookup[] wsAttributeDefLookups1)
wsAttributeDefLookups1
- public String getFieldType()
public void setFieldType(String fieldType1)
fieldType1
- public String getServiceRole()
public void setServiceRole(String serviceRole1)
serviceRole1
- public WsAttributeDefNameLookup getServiceLookup()
public void setServiceLookup(WsAttributeDefNameLookup serviceLookup1)
serviceLookup1
- public String[] getMembershipIds()
public void setMembershipIds(String[] membershipsIds1)
membershipsIds1
- public String getEnabled()
public void setEnabled(String enabled1)
enabled1
- public String getStemScope()
public void setStemScope(String stemScope1)
stemScope1
- public WsStemLookup getWsStemLookup()
public void setWsStemLookup(WsStemLookup wsStemLookup1)
wsStemLookup1
- public String getScope()
public void setScope(String scope1)
scope1
- public WsSubjectLookup[] getWsSubjectLookups()
public void setWsSubjectLookups(WsSubjectLookup[] wsSubjectLookups1)
wsSubjectLookups1
- public String[] getSourceIds()
public void setSourceIds(String[] sourceIds1)
sourceIds1
- the sourceIds to setpublic String getClientVersion()
public void setClientVersion(String clientVersion1)
clientVersion1
- the clientVersion to setpublic WsGroupLookup[] getWsGroupLookups()
public void setWsGroupLookups(WsGroupLookup[] wsGroupLookups1)
wsGroupLookups1
- the wsGroupLookup to setpublic String getMemberFilter()
public void setMemberFilter(String replaceAllExisting1)
replaceAllExisting1
- the replaceAllExisting to setpublic WsSubjectLookup getActAsSubjectLookup()
public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
actAsSubjectLookup1
- the actAsSubjectLookup to setpublic String getFieldName()
public void setFieldName(String fieldName1)
fieldName1
- the fieldName to setpublic String getIncludeGroupDetail()
public void setIncludeGroupDetail(String includeGroupDetail1)
includeGroupDetail1
- the includeGroupDetail to setpublic String getIncludeSubjectDetail()
public void setIncludeSubjectDetail(String includeSubjectDetail1)
includeSubjectDetail1
- the includeSubjectDetail to setpublic String[] getSubjectAttributeNames()
public void setSubjectAttributeNames(String[] subjectAttributeNames1)
subjectAttributeNames1
- the subjectAttributeNames to setpublic WsParam[] getParams()
public void setParams(WsParam[] params1)
params1
- the params to setpublic String getPageSize()
public void setPageSize(String pageSize1)
pageSize1
- public String getPageNumber()
public void setPageNumber(String pageNumber1)
pageNumber1
- public String getSortString()
public void setSortString(String sortString1)
sortString1
- public String getAscending()
public void setAscending(String ascending1)
ascending1
- public String getPageSizeForMember()
public void setPageSizeForMember(String pageSizeForMember1)
pageSizeForMember1
- public String getPageNumberForMember()
public void setPageNumberForMember(String pageNumberForMember1)
pageNumberForMember1
- public String getSortStringForMember()
public void setSortStringForMember(String sortStringForMember1)
sortStringForMember1
- public String getAscendingForMember()
public void setAscendingForMember(String ascendingForMember1)
ascendingForMember1
- public String getPageIsCursor()
public void setPageIsCursor(String pageIsCursor)
pageIsCursor
- the pageIsCursor to setpublic String getPageLastCursorField()
public void setPageLastCursorField(String pageLastCursorField)
pageLastCursorField
- the pageLastCursorField to setpublic String getPageLastCursorFieldType()
public void setPageLastCursorFieldType(String pageLastCursorFieldType)
pageLastCursorFieldType
- the pageLastCursorFieldType to setpublic String getPageCursorFieldIncludesLastRetrieved()
public void setPageCursorFieldIncludesLastRetrieved(String pageCursorFieldIncludesLastRetrieved)
pageCursorFieldIncludesLastRetrieved
- the pageCursorFieldIncludesLastRetrieved to setpublic String getPageIsCursorForMember()
public void setPageIsCursorForMember(String pageIsCursorForMember)
pageIsCursorForMember
- the pageIsCursorForMember to setpublic String getPageLastCursorFieldForMember()
public void setPageLastCursorFieldForMember(String pageLastCursorFieldForMember)
pageLastCursorFieldForMember
- the pageLastCursorFieldForMember to setpublic String getPageLastCursorFieldTypeForMember()
public void setPageLastCursorFieldTypeForMember(String pageLastCursorFieldTypeForMember)
pageLastCursorFieldTypeForMember
- the pageLastCursorFieldTypeForMember to setpublic String getPageCursorFieldIncludesLastRetrievedForMember()
public void setPageCursorFieldIncludesLastRetrievedForMember(String pageCursorFieldIncludesLastRetrievedForMember)
pageCursorFieldIncludesLastRetrievedForMember
- the pageCursorFieldIncludesLastRetrievedForMember to setpublic String getPointInTimeRetrieve()
public void setPointInTimeRetrieve(String pointInTimeRetrieve)
pointInTimeRetrieve
- the pointInTimeRetrieve to setpublic String getPointInTimeFrom()
public void setPointInTimeFrom(String pointInTimeFrom)
pointInTimeFrom
- the pointInTimeFrom to setpublic String getPointInTimeTo()
public void setPointInTimeTo(String pointInTimeTo)
pointInTimeTo
- the pointInTimeTo to setCopyright © 2020 Internet2. All rights reserved.