edu.internet2.middleware.grouperClient.api

Class GcFindGroups

java.lang.Object

edu.internet2.middleware.grouperClient.api.GcFindGroups

public class GcFindGroups
extends Object

class to run find groups

Constructor Summary

Constructors

Constructor and Description
GcFindGroups()

Method Summary

Modifier and Type	Method and Description
GcFindGroups	addGroupIdIndex(Long theGroupIdIndex) set the group id index
GcFindGroups	addGroupName(String theGroupName) set the group name
GcFindGroups	addGroupUuid(String theGroupUuid) set the group uuid
GcFindGroups	addParam(String paramName, String paramValue) add a param to the list
GcFindGroups	addParam(WsParam wsParam) add a param to the list
GcFindGroups	assignActAsSubject(WsSubjectLookup theActAsSubject) assign the act as subject if any
GcFindGroups	assignClientVersion(String theClientVersion) assign client version
GcFindGroups	assignIncludeGroupDetail(Boolean theIncludeGroupDetail) assign if the group detail should be included
GcFindGroups	assignQueryFilter(WsQueryFilter theQueryFilter) assign a query filter
WsFindGroupsResults	execute() execute the call and return the results.

Methods inherited from class java.lang.Object

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

Constructor Detail

GcFindGroups

public GcFindGroups()

Method Detail

assignQueryFilter

public GcFindGroups assignQueryFilter(WsQueryFilter theQueryFilter)

assign a query filter

Parameters:

theQueryFilter -

Returns:

this for chaining

assignClientVersion

public GcFindGroups assignClientVersion(String theClientVersion)

assign client version

Parameters:

theClientVersion -

Returns:

this for chaining

addParam

public GcFindGroups addParam(String paramName,
                             String paramValue)

add a param to the list

Parameters:

paramName -

paramValue -

Returns:

this for chaining

addParam

public GcFindGroups addParam(WsParam wsParam)

add a param to the list

Parameters:

wsParam -

Returns:

this for chaining

assignActAsSubject

public GcFindGroups assignActAsSubject(WsSubjectLookup theActAsSubject)

assign the act as subject if any

Parameters:

theActAsSubject -

Returns:

this for chaining

assignIncludeGroupDetail

public GcFindGroups assignIncludeGroupDetail(Boolean theIncludeGroupDetail)

assign if the group detail should be included

Parameters:

theIncludeGroupDetail -

Returns:

this for chaining

execute

public WsFindGroupsResults execute()

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

Returns:

the results

addGroupName

public GcFindGroups addGroupName(String theGroupName)

set the group name

Parameters:

theGroupName -

Returns:

this for chaining

addGroupUuid

public GcFindGroups addGroupUuid(String theGroupUuid)

set the group uuid

Parameters:

theGroupUuid -

Returns:

this for chaining

addGroupIdIndex

public GcFindGroups addGroupIdIndex(Long theGroupIdIndex)

set the group id index

Parameters:

theGroupIdIndex -

Returns:

this for chaining