edu.internet2.middleware.grouperClient.api

Class GcGetGroups

java.lang.Object

edu.internet2.middleware.grouperClient.api.GcGetGroups

public class GcGetGroups
extends Object

class to run a get groups web service call

Constructor Summary

Constructors

Constructor and Description
GcGetGroups()

Method Summary

Methods

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	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)

Methods inherited from class java.lang.Object

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

Constructor Detail

GcGetGroups

public GcGetGroups()

Method Detail

assignClientVersion

public GcGetGroups assignClientVersion(String theClientVersion)

assign client version

Parameters:

theClientVersion -

Returns:

this for chaining

addParam

public GcGetGroups addParam(String paramName,
                   String paramValue)

add a param to the list

Parameters:

paramName -

paramValue -

Returns:

this for chaining

addParam

public GcGetGroups addParam(WsParam wsParam)

add a param to the list

Parameters:

wsParam -

Returns:

this for chaining

addSubjectLookup

public GcGetGroups addSubjectLookup(WsSubjectLookup wsSubjectLookup)

add a subject lookup

Parameters:

wsSubjectLookup -

Returns:

this for chaining

addSubjectId

public GcGetGroups addSubjectId(String subjectId)

add a subject lookup

Parameters:

subjectId -

Returns:

this for chaining

addSubjectIdentifier

public GcGetGroups addSubjectIdentifier(String subjectIdentifier)

add a subject lookup

Parameters:

subjectIdentifier -

Returns:

this for chaining

assignFieldName

public GcGetGroups assignFieldName(String theFieldName)

assign field name, blank for default members list

Parameters:

theFieldName -

Returns:

this for chaining

assignActAsSubject

public GcGetGroups assignActAsSubject(WsSubjectLookup theActAsSubject)

assign the act as subject if any

Parameters:

theActAsSubject -

Returns:

this for chaining

assignScope

public GcGetGroups assignScope(String theScope)

scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:

Parameters:

theScope -

Returns:

this for chaining

assignWsStemLookup

public GcGetGroups assignWsStemLookup(WsStemLookup theWsStemLookup)

is the stem to check in, or null if all. If has stem, must have stemScope

Parameters:

theWsStemLookup -

Returns:

this for chaining

assignStemScope

public GcGetGroups assignStemScope(StemScope theStemScope)

stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stem

Parameters:

theStemScope -

Returns:

this for chaining

assignEnabled

public GcGetGroups assignEnabled(Boolean theEnabled)

enabled is null for all, true for only enabled, false for only disabled

Parameters:

theEnabled -

Returns:

this for chaining

assignPageSize

public GcGetGroups assignPageSize(Integer thePageSize)

pageSize page size if paging

Parameters:

thePageSize -

Returns:

this for chaining

assignPageNumber

public GcGetGroups assignPageNumber(Integer thePageNumber)

pageNumber page number 1 indexed if paging

Parameters:

thePageNumber -

Returns:

this for chaining

assignSortString

public GcGetGroups assignSortString(String theSortString)

sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension

Parameters:

theSortString -

Returns:

this for chaining

assignAscending

public GcGetGroups assignAscending(Boolean theAscending)

ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string

Parameters:

theAscending -

Returns:

this for chaining

addSubjectAttributeName

public GcGetGroups addSubjectAttributeName(String subjectAttributeName)

Parameters:

subjectAttributeName -

Returns:

this for chaining

assignIncludeGroupDetail

public GcGetGroups assignIncludeGroupDetail(Boolean theIncludeGroupDetail)

assign if the group detail should be included

Parameters:

theIncludeGroupDetail -

Returns:

this for chaining

assignIncludeSubjectDetail

public GcGetGroups assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)

if should include subject detail

Parameters:

theIncludeSubjectDetail -

Returns:

this for chaining

assignPointInTimeFrom

public 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. 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 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. 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 WsGetGroupsResults execute()

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

Returns:

the results

assignMemberFilter

public GcGetGroups assignMemberFilter(WsMemberFilter theMemberFilter)

assign the member filter

Parameters:

theMemberFilter -

Returns:

this for chaining

main

public static void main(String[] args)

Parameters:

args -