public class GcGetGroups extends Object
| Constructor and Description |
|---|
GcGetGroups() |
| Modifier and Type | Method and Description |
|---|---|
GcGetGroups |
addParam(String paramName,
String paramValue)
add a param to the list
|
GcGetGroups |
addParam(WsParam wsParam)
add a param to the list
|
GcGetGroups |
addSubjectAttributeName(String subjectAttributeName) |
GcGetGroups |
addSubjectId(String subjectId)
add a subject lookup
|
GcGetGroups |
addSubjectIdentifier(String subjectIdentifier)
add a subject lookup
|
GcGetGroups |
addSubjectLookup(WsSubjectLookup wsSubjectLookup)
add a subject lookup
|
GcGetGroups |
assignActAsSubject(WsSubjectLookup theActAsSubject)
assign the act as subject if any
|
GcGetGroups |
assignAscending(Boolean theAscending)
ascending or null for ascending, F for descending.
|
GcGetGroups |
assignClientVersion(String theClientVersion)
assign client version
|
GcGetGroups |
assignEnabled(Boolean theEnabled)
enabled is null for all, true for only enabled, false for only disabled
|
GcGetGroups |
assignFieldName(String theFieldName)
assign field name, blank for default members list
|
GcGetGroups |
assignIncludeGroupDetail(Boolean theIncludeGroupDetail)
assign if the group detail should be included
|
GcGetGroups |
assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)
if should include subject detail
|
GcGetGroups |
assignMemberFilter(WsMemberFilter theMemberFilter)
assign the member filter
|
GcGetGroups |
assignPageCursorFieldIncludesLastRetrieved(Boolean pageCursorFieldIncludesLastRetrieved)
should the last retrieved item be included again in the current result set
|
GcGetGroups |
assignPageIsCursor(Boolean pageIsCursor)
T for when pagination is of cursor type.
|
GcGetGroups |
assignPageLastCursorField(String pageLastCursorField)
value of last cursor field
|
GcGetGroups |
assignPageLastCursorFieldType(String pageLastCursorFieldType)
type of last cursor field (string, int, long, date, timestamp)
|
GcGetGroups |
assignPageNumber(Integer thePageNumber)
pageNumber page number 1 indexed if paging
|
GcGetGroups |
assignPageSize(Integer thePageSize)
pageSize page size if paging
|
GcGetGroups |
assignPointInTimeFrom(Timestamp pointInTimeFrom)
To query members at a certain point in time or time range in the past, set this value
and/or the value of pointInTimeTo.
|
GcGetGroups |
assignPointInTimeTo(Timestamp 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.
|
GcGetGroups |
assignScope(String theScope)
scope is a DB pattern that will have % appended to it, or null for all.
|
GcGetGroups |
assignSortString(String theSortString)
sortString must be an hql query field, e.g.
|
GcGetGroups |
assignStemScope(StemScope theStemScope)
stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
|
GcGetGroups |
assignWsStemLookup(WsStemLookup theWsStemLookup)
is the stem to check in, or null if all.
|
WsGetGroupsResults |
execute()
execute the call and return the results.
|
static void |
main(String[] args) |
public GcGetGroups assignClientVersion(String theClientVersion)
theClientVersion - public GcGetGroups addParam(String paramName, String paramValue)
paramName - paramValue - public GcGetGroups addParam(WsParam wsParam)
wsParam - public GcGetGroups addSubjectLookup(WsSubjectLookup wsSubjectLookup)
wsSubjectLookup - public GcGetGroups addSubjectId(String subjectId)
subjectId - public GcGetGroups addSubjectIdentifier(String subjectIdentifier)
subjectIdentifier - public GcGetGroups assignFieldName(String theFieldName)
theFieldName - public GcGetGroups assignActAsSubject(WsSubjectLookup theActAsSubject)
theActAsSubject - public GcGetGroups assignScope(String theScope)
theScope - public GcGetGroups assignWsStemLookup(WsStemLookup theWsStemLookup)
theWsStemLookup - public GcGetGroups assignStemScope(StemScope theStemScope)
theStemScope - public GcGetGroups assignEnabled(Boolean theEnabled)
theEnabled - public GcGetGroups assignPageSize(Integer thePageSize)
thePageSize - public GcGetGroups assignPageNumber(Integer thePageNumber)
thePageNumber - public GcGetGroups assignSortString(String theSortString)
theSortString - public GcGetGroups assignAscending(Boolean theAscending)
theAscending - public GcGetGroups addSubjectAttributeName(String subjectAttributeName)
subjectAttributeName - public GcGetGroups assignIncludeGroupDetail(Boolean theIncludeGroupDetail)
theIncludeGroupDetail - public GcGetGroups assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)
theIncludeSubjectDetail - public GcGetGroups assignPointInTimeFrom(Timestamp pointInTimeFrom)
pointInTimeFrom - public GcGetGroups assignPointInTimeTo(Timestamp pointInTimeTo)
pointInTimeTo - public WsGetGroupsResults execute()
public GcGetGroups assignMemberFilter(WsMemberFilter theMemberFilter)
theMemberFilter - public GcGetGroups assignPageIsCursor(Boolean pageIsCursor)
pageIsCursor - public GcGetGroups assignPageLastCursorField(String pageLastCursorField)
pageLastCursorField - public GcGetGroups assignPageLastCursorFieldType(String pageLastCursorFieldType)
pageLastCursorFieldType - public GcGetGroups assignPageCursorFieldIncludesLastRetrieved(Boolean pageCursorFieldIncludesLastRetrieved)
pageCursorFieldIncludesLastRetrieved - public static void main(String[] args)
args - Copyright © 2020 Internet2. All rights reserved.