edu.internet2.middleware.grouperClient.api

Class GcGetMembers

java.lang.Object

edu.internet2.middleware.grouperClient.api.GcGetMembers

public class GcGetMembers
extends Object

class to run a get members web service call

Constructor Summary

Constructors

Constructor and Description
GcGetMembers()

Method Summary

Modifier and Type	Method and Description
GcGetMembers	addGroupIdIndex(Long theGroupIdIndex) set the group id index
GcGetMembers	addGroupName(String theGroupName) set the group name
GcGetMembers	addGroupUuid(String theGroupUuid) set the group uuid
GcGetMembers	addParam(String paramName, String paramValue) add a param to the list
GcGetMembers	addParam(WsParam wsParam) add a param to the list
GcGetMembers	addSourceId(String sourceId) add a source id to filter by (or none for all sources)
GcGetMembers	addSubjectAttributeName(String subjectAttributeName)
GcGetMembers	assignActAsSubject(WsSubjectLookup theActAsSubject) assign the act as subject if any
void	assignAscending(Boolean ascending1) ascending T or null for ascending, F for descending.
GcGetMembers	assignAutopage(Boolean theAutopage) if should page through results so it doesnt timeout.
GcGetMembers	assignAutopageOverlap(Integer theAutopageOverlap) The overlap of the autopage.
GcGetMembers	assignClientVersion(String theClientVersion) assign client version
GcGetMembers	assignFieldName(String theFieldName) assign the field name to the request
GcGetMembers	assignIncludeGroupDetail(Boolean theIncludeGroupDetail) assign if the group detail should be included
GcGetMembers	assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail) if should include subject detail
GcGetMembers	assignMemberFilter(WsMemberFilter theMemberFilter) assign the member filter
void	assignPageNumber(Integer pageNumber1) page number 1 indexed if paging
void	assignPageSize(Integer pageSize1) page size if paging
GcGetMembers	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.
GcGetMembers	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.
void	assignSortString(String sortString1) sortString must be an hql query field, e.g.
WsGetMembersResults	execute() execute the call and return the results.
static void	main(String[] args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GcGetMembers

public GcGetMembers()

Method Detail

main

public static void main(String[] args)

Parameters:

args -

assignAutopage

public GcGetMembers assignAutopage(Boolean theAutopage)

if should page through results so it doesnt timeout. Note, if pageSize is not set, will page 10k records

Parameters:

theAutopage -

Returns:

this for chaining

assignAutopageOverlap

public GcGetMembers assignAutopageOverlap(Integer theAutopageOverlap)

The overlap of the autopage. Note, should at least be 1, defaults to 5% of the pageSize.

Parameters:

theAutopageOverlap -

Returns:

this for chaining

assignPageSize

public void assignPageSize(Integer pageSize1)

page size if paging

Parameters:

pageSize1 -

assignPageNumber

public void assignPageNumber(Integer pageNumber1)

page number 1 indexed if paging

Parameters:

pageNumber1 -

assignSortString

public void assignSortString(String sortString1)

sortString must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, name, description, sortString0, sortString1, sortString2, sortString3, sortString4

Parameters:

sortString1 -

assignAscending

public void assignAscending(Boolean ascending1)

ascending T or null for ascending, F for descending.

Parameters:

ascending1 -

assignClientVersion

public GcGetMembers assignClientVersion(String theClientVersion)

assign client version

Parameters:

theClientVersion -

Returns:

this for chaining

addGroupName

public GcGetMembers addGroupName(String theGroupName)

set the group name

Parameters:

theGroupName -

Returns:

this for chaining

addGroupIdIndex

public GcGetMembers addGroupIdIndex(Long theGroupIdIndex)

set the group id index

Parameters:

theGroupIdIndex -

Returns:

this for chaining

addGroupUuid

public GcGetMembers addGroupUuid(String theGroupUuid)

set the group uuid

Parameters:

theGroupUuid -

Returns:

this for chaining

addParam

public GcGetMembers addParam(String paramName,
                             String paramValue)

add a param to the list

Parameters:

paramName -

paramValue -

Returns:

this for chaining

addParam

public GcGetMembers addParam(WsParam wsParam)

add a param to the list

Parameters:

wsParam -

Returns:

this for chaining

assignMemberFilter

public GcGetMembers assignMemberFilter(WsMemberFilter theMemberFilter)

assign the member filter

Parameters:

theMemberFilter -

Returns:

this for chaining

assignActAsSubject

public GcGetMembers assignActAsSubject(WsSubjectLookup theActAsSubject)

assign the act as subject if any

Parameters:

theActAsSubject -

Returns:

this for chaining

assignFieldName

public GcGetMembers assignFieldName(String theFieldName)

assign the field name to the request

Parameters:

theFieldName -

Returns:

this for chaining

addSourceId

public GcGetMembers addSourceId(String sourceId)

add a source id to filter by (or none for all sources)

Parameters:

sourceId -

Returns:

this for chaining

addSubjectAttributeName

public GcGetMembers addSubjectAttributeName(String subjectAttributeName)

Parameters:

subjectAttributeName -

Returns:

this for chaining

assignIncludeGroupDetail

public GcGetMembers assignIncludeGroupDetail(Boolean theIncludeGroupDetail)

assign if the group detail should be included

Parameters:

theIncludeGroupDetail -

Returns:

this for chaining

assignIncludeSubjectDetail

public GcGetMembers assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)

if should include subject detail

Parameters:

theIncludeSubjectDetail -

Returns:

this for chaining

assignPointInTimeFrom

public GcGetMembers 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. 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.

Parameters:

pointInTimeFrom -

Returns:

this for chaining

assignPointInTimeTo

public GcGetMembers 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. 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.

Parameters:

pointInTimeTo -

Returns:

this for chaining

execute

public WsGetMembersResults execute()

execute the call and return the results. If there is a problem calling the service, an exception will be thrown

Returns:

the results