Package edu.internet2.middleware.grouperClient.api

Class GcFindAttributeDefs

java.lang.Object
edu.internet2.middleware.grouperClient.api.GcFindAttributeDefs
public class GcFindAttributeDefs extends Object
class to run find attributeDefs

  • Constructor Details

    • GcFindAttributeDefs

      public GcFindAttributeDefs()

  • Method Details

    • assignWsEndpoint

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

    • assignWsUser

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

    • assignWsPass

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

    • assignWsPassEncrypted

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

    • assignWsPassFile

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

    • assignWsPassFileEncrypted

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

    • assignScope

      public GcFindAttributeDefs assignScope(String theScope)
      search string with % as wildcards will search name, display name, description
      Parameters:
      theScope -
      Returns:
      scope

    • assignSplitScope

      public GcFindAttributeDefs assignSplitScope(Boolean theSplitScope)
      T or F, if T will split the scope by whitespace, and find attribute defs with each token. e.g. if you have a scope of "pto permissions", and split scope T, it will return school:apps:pto_app:internal:the_permissions:whatever
      Parameters:
      theSplitScope -
      Returns:
      the split scope

    • assignClientVersion

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

    • assignContentType

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

    • addParam

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

    • addParam

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

    • assignActAsSubject

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

    • assignPrivilege

      public GcFindAttributeDefs assignPrivilege(String thePrivilegeName)
      assign privilege name
      Parameters:
      privilegeName -
      Returns:
      this

    • assignAscending

      public GcFindAttributeDefs assignAscending(Boolean isAscending)
      assign if ascending if sorting
      Parameters:
      isAscending -
      Returns:
      this for paging

    • assignPageNumber

      public GcFindAttributeDefs assignPageNumber(Integer thePageNumber)
      assign page number if paging
      Parameters:
      thePageNumber -
      Returns:
      this for chaining

    • assignPageSize

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

    • assignSortString

      public GcFindAttributeDefs assignSortString(String theSortString)
      assign sort string if sorting, e.g. can sort on name, displayName, extension, displayExtension
      Parameters:
      theSortString -
      Returns:
      the sort string

    • assignPageIsCursor

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

    • assignPageLastCursorField

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

    • assignPageLastCursorFieldType

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

    • assignPageCursorFieldIncludesLastRetrieved

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

    • execute

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

    • addAttributeDefName

      public GcFindAttributeDefs addAttributeDefName(String theAttributeDefName)
      set the AttributeDef name
      Parameters:
      theAttributeDefName -
      Returns:
      this for chaining

    • addAttributeDefUuid

      public GcFindAttributeDefs addAttributeDefUuid(String theAttributeDefUuid)
      set the AttributeDef uuid
      Parameters:
      theAttributeDefUuid -
      Returns:
      this for chaining

    • addAttributeDefIdIndex

      public GcFindAttributeDefs addAttributeDefIdIndex(Long theAttributeDefIdIndex)
      set the AttributeDef id index
      Parameters:
      theAttributeDefIdIndex -
      Returns:
      this for chaining