Class GcFindStems

java.lang.Object
edu.internet2.middleware.grouperClient.api.GcFindStems

public class GcFindStems extends Object
class to run find stems
  • Constructor Details

    • GcFindStems

      public GcFindStems()
  • Method Details

    • assignWsEndpoint

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

      public GcFindStems assignWsUser(String theWsUser)
      ws user
      Parameters:
      theWsUser -
      Returns:
      this for chaining
    • assignWsPass

      public GcFindStems assignWsPass(String theWsPass)
      ws pass
      Parameters:
      theWsPass -
      Returns:
      this for chaining
    • assignWsPassEncrypted

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

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

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

      public GcFindStems assignStemQueryFilter(WsStemQueryFilter theStemQueryFilter)
      assign a query filter
      Parameters:
      theStemQueryFilter -
      Returns:
      this for chaining
    • assignClientVersion

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

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

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

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

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

      public WsFindStemsResults execute()
      execute the call and return the results. If there is a problem calling the service, an exception will be thrown
      Returns:
      the results
    • addStemName

      public GcFindStems addStemName(String theStemName)
      set the stem name
      Parameters:
      theStemName -
      Returns:
      this for chaining
    • addStemUuid

      public GcFindStems addStemUuid(String theStemUuid)
      set the stem uuid
      Parameters:
      theStemUuid -
      Returns:
      this for chaining
    • addStemIdIndex

      public GcFindStems addStemIdIndex(Long theStemIdIndex)
      set the stem id index
      Parameters:
      theStemIdIndex -
      Returns:
      this for chaining