Package edu.internet2.middleware.grouperClient.api

Class GcGetSubjects

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

  • Constructor Details

    • GcGetSubjects

      public GcGetSubjects()

  • Method Details

    • assignWsEndpoint

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

    • assignWsUser

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

    • assignWsPass

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

    • assignWsPassEncrypted

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

    • assignWsPassFile

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

    • assignWsPassFileEncrypted

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

    • assignSearchString

      public GcGetSubjects assignSearchString(String theSearchString)
      assign the search string
      Parameters:
      theSearchString -
      Returns:
      this for chaining

    • assignGroupLookup

      public GcGetSubjects assignGroupLookup(WsGroupLookup theGroupLookup)
      assign a group to filter subjects from
      Parameters:
      theGroupLookup -
      Returns:
      this for chaining

    • assignClientVersion

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

    • addWsSubjectLookup

      public GcGetSubjects addWsSubjectLookup(WsSubjectLookup wsSubjectLookup)
      set the subject lookup
      Parameters:
      wsSubjectLookup -
      Returns:
      this for chaining

    • addParam

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

    • addParam

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

    • assignMemberFilter

      public GcGetSubjects assignMemberFilter(WsMemberFilter theMemberFilter)
      assign the member filter
      Parameters:
      theMemberFilter -
      Returns:
      this for chaining

    • assignActAsSubject

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

    • assignFieldName

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

    • addSourceId

      public GcGetSubjects addSourceId(String sourceId)
      add a source id to filter by (or none for all sources)
      Parameters:
      sourceId -
      Returns:
      this for chaining

    • addSubjectAttributeName

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

    • assignIncludeGroupDetail

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

    • assignIncludeSubjectDetail

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

    • execute

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