Package edu.internet2.middleware.grouperClient.api

Class GcHasMember

java.lang.Object
edu.internet2.middleware.grouperClient.api.GcHasMember
public class GcHasMember extends Object
class to run a has member web service call

  • Constructor Details

    • GcHasMember

      public GcHasMember()

  • Method Details

    • assignWsEndpoint

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

    • assignWsUser

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

    • assignWsPass

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

    • assignWsPassEncrypted

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

    • assignWsPassFile

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

    • assignWsPassFileEncrypted

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

    • assignClientVersion

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

    • assignGroupName

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

    • assignGroupUuid

      public GcHasMember assignGroupUuid(String theGroupUuid)
      set the group uuid
      Parameters:
      theGroupUuid -
      Returns:
      this for chaining

    • assignGroupIdIndex

      public GcHasMember assignGroupIdIndex(Long theGroupIdIndex)
      set the group id index
      Parameters:
      theGroupIdIndex -
      Returns:
      this for chaining

    • addParam

      public GcHasMember addParam(String paramName, String paramValue)
      add a param to the list
      Parameters:
      paramName -
      paramValue -
      Returns:
      this for chaining

    • addParam

      public GcHasMember addParam(WsParam wsParam)
      add a param to the list
      Parameters:
      wsParam -
      Returns:
      this for chaining

    • addSubjectLookup

      public GcHasMember addSubjectLookup(WsSubjectLookup wsSubjectLookup)
      add a subject lookup
      Parameters:
      wsSubjectLookup -
      Returns:
      this for chaining

    • addSubjectId

      public GcHasMember addSubjectId(String subjectId)
      add a subject lookup
      Parameters:
      subjectId -
      Returns:
      this for chaining

    • addSubjectIdentifier

      public GcHasMember addSubjectIdentifier(String subjectIdentifier)
      add a subject lookup
      Parameters:
      subjectIdentifier -
      Returns:
      this for chaining

    • assignActAsSubject

      public GcHasMember assignActAsSubject(WsSubjectLookup theActAsSubject)
      assign the act as subject if any
      Parameters:
      theActAsSubject -
      Returns:
      this for chaining

    • assignFieldName

      public GcHasMember assignFieldName(String theFieldName)
      assign the field name to the request
      Parameters:
      theFieldName -
      Returns:
      this for chaining

    • addSubjectAttributeName

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

    • assignIncludeGroupDetail

      public GcHasMember assignIncludeGroupDetail(Boolean theIncludeGroupDetail)
      assign if the group detail should be included
      Parameters:
      theIncludeGroupDetail -
      Returns:
      this for chaining

    • assignIncludeSubjectDetail

      public GcHasMember assignIncludeSubjectDetail(Boolean theIncludeSubjectDetail)
      if should include subject detail
      Parameters:
      theIncludeSubjectDetail -
      Returns:
      this for chaining

    • assignPointInTimeFrom

      public GcHasMember 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 GcHasMember 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 WsHasMemberResults 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 GcHasMember assignMemberFilter(WsMemberFilter theMemberFilter)
      assign the member filter
      Parameters:
      theMemberFilter -
      Returns:
      this for chaining