Package edu.internet2.middleware.grouperClient.api

Class GcGetMemberships

java.lang.Object
edu.internet2.middleware.grouperClient.api.GcGetMemberships
public class GcGetMemberships extends Object
class to run a get memberships web service call

  • Constructor Details

    • GcGetMemberships

      public GcGetMemberships()

  • Method Details

    • assignWsEndpoint

      public GcGetMemberships assignWsEndpoint(String theWsEndpoint)
      endpoint to grouper WS, e.g. https://server.school.edu/grouper-ws/servicesRest
      Parameters:
      theWsEndpoint -
      Returns:
      this for chaining

    • assignWsUser

      public GcGetMemberships assignWsUser(String theWsUser)
      ws user
      Parameters:
      theWsUser -
      Returns:
      this for chaining

    • assignWsPass

      public GcGetMemberships assignWsPass(String theWsPass)
      ws pass
      Parameters:
      theWsPass -
      Returns:
      this for chaining

    • assignWsPassEncrypted

      public GcGetMemberships assignWsPassEncrypted(String theWsPassEncrypted)
      ws pass
      Parameters:
      theWsPass -
      Returns:
      this for chaining

    • assignWsPassFile

      public GcGetMemberships assignWsPassFile(File theFile)
      ws pass
      Parameters:
      theWsPass -
      Returns:
      this for chaining

    • assignWsPassFileEncrypted

      public GcGetMemberships assignWsPassFileEncrypted(File theFile)
      ws pass
      Parameters:
      theWsPass -
      Returns:
      this for chaining

    • assignClientVersion

      public GcGetMemberships assignClientVersion(String theClientVersion)
      assign client version
      Parameters:
      theClientVersion -
      Returns:
      this for chaining

    • assignContentType

      public GcGetMemberships assignContentType(String theContentType)
      content type for post request
      Parameters:
      theContentType -
      Returns:
      this for chaining

    • assignWsStem

      public GcGetMemberships assignWsStem(WsStemLookup theWsStemLookup)
      assign stem to limit memberships
      Parameters:
      theWsStemLookup -
      Returns:
      this for chaining

    • assignPageSize

      public GcGetMemberships assignPageSize(Integer thePageSize)
      pageSize page size if paging
      Parameters:
      thePageSize -
      Returns:
      this for chaining

    • assignPageNumber

      public GcGetMemberships assignPageNumber(Integer thePageNumber)
      Parameters:
      thePageNumber -
      Returns:
      this for chaining

    • assignSortString

      public GcGetMemberships assignSortString(String theSortString)
      must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
      Parameters:
      theSortString -
      Returns:
      this for chaining

    • assignAscending

      public GcGetMemberships assignAscending(Boolean theAscending)
      T or null for ascending, F for descending.
      Parameters:
      theAscending -
      Returns:
      this for chaining

    • assignPageSizeForMember

      public GcGetMemberships assignPageSizeForMember(Integer thePageSizeForMember)
      page size if paging in the members part
      Parameters:
      thePageSizeForMember -
      Returns:
      this for chaining

    • assignPageNumberForMember

      public GcGetMemberships assignPageNumberForMember(Integer thePageNumberForMember)
      page number 1 indexed if paging in the members part
      Parameters:
      thePageNumberForMember -
      Returns:
      this for chaining

    • assignSortStringForMember

      public GcGetMemberships assignSortStringForMember(String theSortStringForMember)
      must be an hql query field, e.g. can sort on uuid, subjectId, sourceId, sourceString0, sortString1, sortString2, sortString3, sortString4, name, description in the members part
      Parameters:
      theSortStringForMember -
      Returns:
      this for chaining

    • assignAscendingForMember

      public GcGetMemberships assignAscendingForMember(Boolean theAscendingForMember)
      T or null for ascending, F for descending in the members part
      Parameters:
      theAscendingForMember -
      Returns:
      this for chaining

    • assignPageIsCursor

      public GcGetMemberships assignPageIsCursor(Boolean pageIsCursor)
      T for when pagination is of cursor type. F or null otherwise
      Parameters:
      pageIsCursor -
      Returns:

    • assignPageLastCursorField

      public GcGetMemberships assignPageLastCursorField(String pageLastCursorField)
      value of last cursor field
      Parameters:
      pageLastCursorField -
      Returns:

    • assignPageLastCursorFieldType

      public GcGetMemberships assignPageLastCursorFieldType(String pageLastCursorFieldType)
      type of last cursor field (string, int, long, date, timestamp)
      Parameters:
      pageLastCursorFieldType -
      Returns:

    • assignPageCursorFieldIncludesLastRetrieved

      public GcGetMemberships assignPageCursorFieldIncludesLastRetrieved(Boolean pageCursorFieldIncludesLastRetrieved)
      should the last retrieved item be included again in the current result set
      Parameters:
      pageCursorFieldIncludesLastRetrieved -
      Returns:

    • assignPageIsCursorForMember

      public GcGetMemberships assignPageIsCursorForMember(Boolean pageIsCursorForMember)
      T for when pagination is of cursor type. F or null otherwise
      Parameters:
      pageIsCursorForMember -
      Returns:

    • assignPageLastCursorFieldForMember

      public GcGetMemberships assignPageLastCursorFieldForMember(String pageLastCursorFieldForMember)
      value of last cursor field for member results
      Parameters:
      pageLastCursorFieldForMember -
      Returns:

    • assignPageLastCursorFieldTypeForMember

      public GcGetMemberships assignPageLastCursorFieldTypeForMember(String pageLastCursorFieldTypeForMember)
      type of last cursor field (string, int, long, date, timestamp) for member results
      Parameters:
      pageLastCursorFieldTypeForMember -
      Returns:

    • assignPageCursorFieldIncludesLastRetrievedForMember

      public GcGetMemberships assignPageCursorFieldIncludesLastRetrievedForMember(Boolean pageCursorFieldIncludesLastRetrievedForMember)
      should the last retrieved item be included again in the current result set for member results
      Parameters:
      pageCursorFieldIncludesLastRetrievedForMember -
      Returns:

    • assignPointInTimeRetrieve

      public GcGetMemberships assignPointInTimeRetrieve(Boolean pointInTimeRetrieve)
      is the query point in time retrieve
      Parameters:
      pointInTimeRetrieve -
      Returns:

    • assignPointInTimeFrom

      public GcGetMemberships assignPointInTimeFrom(Timestamp pointInTimeFrom)

    • assignPointInTimeTo

      public GcGetMemberships assignPointInTimeTo(Timestamp pointInTimeTo)
      if the query is point in time, end date
      Parameters:
      pointInTimeTo -
      Returns:

    • addGroupName

      public GcGetMemberships addGroupName(String theGroupName)
      set the group name
      Parameters:
      theGroupName -
      Returns:
      this for chaining

    • addGroupIdIndex

      public GcGetMemberships addGroupIdIndex(Long theGroupIdIndex)
      set the group id index
      Parameters:
      theGroupIdIndex -
      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:
      theOwnerNameOfAttributeDef -
      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 -
      Returns:
      this for chaining

    • assignServiceLookup

      public GcGetMemberships assignServiceLookup(WsAttributeDefNameLookup serviceLookup1)
      serviceLookup if filtering by users in a service, then this is the service to look in
      Parameters:
      serviceLookup1 -
      Returns:
      this for chaining

    • assignServiceRole

      public GcGetMemberships assignServiceRole(String serviceRole1)
      serviceRole to filter attributes that a user has a certain role
      Parameters:
      serviceRole1 -
      Returns:
      this for chaining

    • 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