edu.internet2.middleware.grouperClient.api
Class GcGetMemberships

java.lang.Object
  extended by edu.internet2.middleware.grouperClient.api.GcGetMemberships

public class GcGetMemberships
extends Object

class to run a get memberships web service call


Constructor Summary
GcGetMemberships()
           
 
Method Summary
 GcGetMemberships addGroupName(String theGroupName)
          set the group name
 GcGetMemberships addGroupUuid(String theGroupUuid)
          set the group uuid
 GcGetMemberships addMembershipId(String sourceId)
          add a source id to filter by (or none for all sources)
 GcGetMemberships addOwnerNameOfAttributeDef(String theOwnerNameOfAttributeDef)
          set the owner attributeDef name
 GcGetMemberships addOwnerStemName(String theOwnerStemName)
          set the owner stem name
 GcGetMemberships addOwnerStemUuid(String theOwnerStemUuid)
          set the owner stem uuid
 GcGetMemberships addOwnerUuidOfAttributeDef(String theOwnerUuidOfAttributeDef)
          set the owner attributeDef uuid
 GcGetMemberships addParam(String paramName, String paramValue)
          add a param to the list
 GcGetMemberships addParam(WsParam wsParam)
          add a param to the list
 GcGetMemberships addSourceId(String sourceId)
          add a source id to filter by (or none for all sources)
 GcGetMemberships addSubjectAttributeName(String subjectAttributeName)
           
 GcGetMemberships addWsSubjectLookup(WsSubjectLookup wsSubjectLookup)
          set the subject lookup
 GcGetMemberships assignActAsSubject(WsSubjectLookup theActAsSubject)
          assign the act as subject if any
 GcGetMemberships assignClientVersion(String theClientVersion)
          assign client version
 GcGetMemberships assignEnabled(String theEnabled)
          assign A for all, T or null for enabled only, F for disabled only
 GcGetMemberships assignFieldName(String theFieldName)
          assign the field name to the request
 GcGetMemberships assignFieldType(String fieldType1)
          fieldType is the type of field to look at, e.g.
 GcGetMemberships assignIncludeGroupDetail(Boolean theIncludeGroupDetail)
          assign if the group detail should be included
 GcGetMemberships assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)
          if should include subject detail
 GcGetMemberships assignMemberFilter(WsMemberFilter theMemberFilter)
          assign the member filter
 GcGetMemberships assignScope(String theScope)
          assign the sql like string which filters the memberships
 GcGetMemberships assignStemScope(String theStemScope)
          assign ONE_LEVEL|ALL_IN_SUBTREE to stem scope
 GcGetMemberships assignWsStem(WsStemLookup theWsStemLookup)
          assign stem to limit memberships
 GcGetMemberships assigStemScope(String theStemScope)
          Deprecated. use assignStemScope
 WsGetMembershipsResults execute()
          execute the call and return the results.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GcGetMemberships

public GcGetMemberships()
Method Detail

assignClientVersion

public GcGetMemberships assignClientVersion(String theClientVersion)
assign client version

Parameters:
theClientVersion -
Returns:
this for chaining

assignWsStem

public GcGetMemberships assignWsStem(WsStemLookup theWsStemLookup)
assign stem to limit memberships

Parameters:
theWsStemLookup -
Returns:
this for chaining

addGroupName

public GcGetMemberships addGroupName(String theGroupName)
set the group name

Parameters:
theGroupName -
Returns:
this for chaining

addOwnerStemName

public GcGetMemberships addOwnerStemName(String theOwnerStemName)
set the owner stem name

Parameters:
theOwnerStemName -
Returns:
this for chaining

addOwnerStemUuid

public GcGetMemberships addOwnerStemUuid(String theOwnerStemUuid)
set the owner stem uuid

Parameters:
theOwnerStemUuid -
Returns:
this for chaining

addOwnerNameOfAttributeDef

public GcGetMemberships addOwnerNameOfAttributeDef(String theOwnerNameOfAttributeDef)
set the owner attributeDef name

Parameters:
theOwnerAttributeDefName -
Returns:
this for chaining

addOwnerUuidOfAttributeDef

public GcGetMemberships addOwnerUuidOfAttributeDef(String theOwnerUuidOfAttributeDef)
set the owner attributeDef uuid

Parameters:
theOwnerUuidOfAttributeDef -
Returns:
this for chaining

addWsSubjectLookup

public GcGetMemberships addWsSubjectLookup(WsSubjectLookup wsSubjectLookup)
set the subject lookup

Parameters:
wsSubjectLookup -
Returns:
this for chaining

addGroupUuid

public GcGetMemberships addGroupUuid(String theGroupUuid)
set the group uuid

Parameters:
theGroupUuid -
Returns:
this for chaining

addParam

public GcGetMemberships addParam(String paramName,
                                 String paramValue)
add a param to the list

Parameters:
paramName -
paramValue -
Returns:
this for chaining

addParam

public GcGetMemberships addParam(WsParam wsParam)
add a param to the list

Parameters:
wsParam -
Returns:
this for chaining

assignMemberFilter

public GcGetMemberships assignMemberFilter(WsMemberFilter theMemberFilter)
assign the member filter

Parameters:
theMemberFilter -
Returns:
this for chaining

assignActAsSubject

public GcGetMemberships assignActAsSubject(WsSubjectLookup theActAsSubject)
assign the act as subject if any

Parameters:
theActAsSubject -
Returns:
this for chaining

assignFieldType

public GcGetMemberships assignFieldType(String fieldType1)
fieldType is the type of field to look at, e.g. list (default, memberships), access (privs on groups), attribute_def (privs on attribute definitions), naming (privs on folders)

Parameters:
fieldType1 -

assignFieldName

public GcGetMemberships assignFieldName(String theFieldName)
assign the field name to the request

Parameters:
theFieldName -
Returns:
this for chaining

assignScope

public GcGetMemberships assignScope(String theScope)
assign the sql like string which filters the memberships

Parameters:
theScope -
Returns:
this for chaining

addSourceId

public GcGetMemberships addSourceId(String sourceId)
add a source id to filter by (or none for all sources)

Parameters:
sourceId -
Returns:
this for chaining

addMembershipId

public GcGetMemberships addMembershipId(String sourceId)
add a source id to filter by (or none for all sources)

Parameters:
sourceId -
Returns:
this for chaining

addSubjectAttributeName

public GcGetMemberships addSubjectAttributeName(String subjectAttributeName)
Parameters:
subjectAttributeName -
Returns:
this for chaining

assignIncludeGroupDetail

public GcGetMemberships assignIncludeGroupDetail(Boolean theIncludeGroupDetail)
assign if the group detail should be included

Parameters:
theIncludeGroupDetail -
Returns:
this for chaining

assignIncludeSubjectDetail

public GcGetMemberships assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)
if should include subject detail

Parameters:
theIncludeSubjectDetail -
Returns:
this for chaining

execute

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

Returns:
the results

assigStemScope

@Deprecated
public GcGetMemberships assigStemScope(String theStemScope)
Deprecated. use assignStemScope

assign ONE_LEVEL|ALL_IN_SUBTREE to stem scope

Parameters:
theStemScope -
Returns:
this for chaining

assignStemScope

public GcGetMemberships assignStemScope(String theStemScope)
assign ONE_LEVEL|ALL_IN_SUBTREE to stem scope

Parameters:
theStemScope -
Returns:
this for chaining

assignEnabled

public GcGetMemberships assignEnabled(String theEnabled)
assign A for all, T or null for enabled only, F for disabled only

Parameters:
theEnabled -
Returns:
this for chaining