Package edu.internet2.middleware.grouper.ws.rest.attribute

Class WsRestFindAttributeDefNamesRequest

java.lang.Object
edu.internet2.middleware.grouper.ws.rest.attribute.WsRestFindAttributeDefNamesRequest
All Implemented Interfaces:
WsRequestBean
public class WsRestFindAttributeDefNamesRequest extends Object implements WsRequestBean
request bean in body of rest request

  • Constructor Details

    • WsRestFindAttributeDefNamesRequest

      public WsRestFindAttributeDefNamesRequest()

  • Method Details

    • getSubjectLookup

      public WsSubjectLookup getSubjectLookup()
      subject if looking for privileges or service role
      Returns:
      subject

    • setSubjectLookup

      public void setSubjectLookup(WsSubjectLookup subjectLookup1)
      subject if looking for privileges or service role
      Parameters:
      subjectLookup1 -

    • getServiceRole

      public String getServiceRole()
      from ServiceRole enum, which service role you are querying e.g. admin or user
      Returns:
      service role

    • setServiceRole

      public void setServiceRole(String serviceRole1)
      from ServiceRole enum, which service role you are querying e.g. admin or user
      Parameters:
      serviceRole1 -

    • getScope

      public String getScope()
      search string with % as wildcards will search name, display name, description
      Returns:
      the scope

    • setScope

      public void setScope(String scope1)
      search string with % as wildcards will search name, display name, description
      Parameters:
      scope1 - the scope to set

    • getSplitScope

      public String getSplitScope()
      splitScope T or F, if T will split the scope by whitespace, and find attribute def names 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
      Returns:
      the splitScope

    • setSplitScope

      public void setSplitScope(String splitScope1)
      splitScope T or F, if T will split the scope by whitespace, and find attribute def names 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:
      splitScope1 - the splitScope to set

    • getWsAttributeDefLookup

      public WsAttributeDefLookup getWsAttributeDefLookup()
      find names associated with this attribute definition
      Returns:
      the wsAttributeDefLookup

    • setWsAttributeDefLookup

      public void setWsAttributeDefLookup(WsAttributeDefLookup wsAttributeDefLookup1)
      find names associated with this attribute definition
      Parameters:
      wsAttributeDefLookup1 - the wsAttributeDefLookup to set

    • getAttributeAssignType

      public String getAttributeAssignType()
      where can the attribute definition be assigned, e.g. any_mem, any_mem_asgn, attr_def, attr_def_asgn, group, group_asgn, imm_mem, imm_mem_asgn, mem_asgn, member, stem, stem_asgn
      Returns:
      the attributeAssignType

    • setAttributeAssignType

      public void setAttributeAssignType(String attributeAssignType1)
      where can the attribute definition be assigned, e.g. any_mem, any_mem_asgn, attr_def, attr_def_asgn, group, group_asgn, imm_mem, imm_mem_asgn, mem_asgn, member, stem, stem_asgn
      Parameters:
      attributeAssignType1 - the attributeAssignType to set

    • getAttributeDefType

      public String getAttributeDefType()
      type of attribute definition, e.g. attr, domain, limit, perm, type
      Returns:
      the attributeDefType

    • setAttributeDefType

      public void setAttributeDefType(String attributeDefType1)
      type of attribute definition, e.g. attr, domain, limit, perm, type
      Parameters:
      attributeDefType1 - the attributeDefType to set

    • getWsAttributeDefNameLookups

      public WsAttributeDefNameLookup[] getWsAttributeDefNameLookups()
      if you want to just pass in a list of uuids and/or names.
      Returns:
      the wsAttributeDefNameLookups

    • setWsAttributeDefNameLookups

      public void setWsAttributeDefNameLookups(WsAttributeDefNameLookup[] wsAttributeDefNameLookups1)
      if you want to just pass in a list of uuids and/or names.
      Parameters:
      wsAttributeDefNameLookups1 - the wsAttributeDefNameLookups to set

    • getPageSize

      public String getPageSize()
      page size if paging on a sort filter or parent
      Returns:
      the pageSize

    • setPageSize

      public void setPageSize(String pageSize1)
      page size if paging on a sort filter or parent
      Parameters:
      pageSize1 - the pageSize to set

    • getPageNumber

      public String getPageNumber()
      page number 1 indexed if paging on a sort filter or parent
      Returns:
      the pageNumber

    • setPageNumber

      public void setPageNumber(String pageNumber1)
      page number 1 indexed if paging on a sort filter or parent
      Parameters:
      pageNumber1 - the pageNumber to set

    • getSortString

      public String getSortString()
      must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
      Returns:
      the sortString

    • setSortString

      public void setSortString(String sortString1)
      must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
      Parameters:
      sortString1 - the sortString to set

    • getAscending

      public String getAscending()
      ascending or null for ascending, F for descending.
      Returns:
      the ascending

    • setAscending

      public void setAscending(String ascending1)
      ascending or null for ascending, F for descending.
      Parameters:
      ascending1 - the ascending to set

    • getWsInheritanceSetRelation

      public String getWsInheritanceSetRelation()
      wsInheritanceSetRelation if there is one wsAttributeDefNameLookup, and this is specified, then find the attribute def names which are related to the lookup by this relation, e.g. IMPLIED_BY_THIS, IMPLIED_BY_THIS_IMMEDIATE, THAT_IMPLY_THIS, THAT_IMPLY_THIS_IMMEDIATE
      Returns:
      the wsInheritanceSetRelation

    • setWsInheritanceSetRelation

      public void setWsInheritanceSetRelation(String wsInheritanceSetRelation1)
      wsInheritanceSetRelation if there is one wsAttributeDefNameLookup, and this is specified, then find the attribute def names which are related to the lookup by this relation, e.g. IMPLIED_BY_THIS, IMPLIED_BY_THIS_IMMEDIATE, THAT_IMPLY_THIS, THAT_IMPLY_THIS_IMMEDIATE
      Parameters:
      wsInheritanceSetRelation1 - the wsInheritanceSetRelation to set

    • retrieveRestHttpMethod

      public GrouperRestHttpMethod retrieveRestHttpMethod()
      Description copied from interface: WsRequestBean
      see which http method this is supposed to be associated with, and override whatever was passed in
      Specified by:
      retrieveRestHttpMethod in interface WsRequestBean
      Returns:
      the method
      See Also:

    • getClientVersion

      public String getClientVersion()
      is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      Returns:
      version

    • setClientVersion

      public void setClientVersion(String clientVersion1)
      is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
      Parameters:
      clientVersion1 -

    • getActAsSubjectLookup

      public WsSubjectLookup getActAsSubjectLookup()
      if acting as someone else
      Returns:
      act as subject

    • setActAsSubjectLookup

      public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
      if acting as someone else
      Parameters:
      actAsSubjectLookup1 -

    • getParams

      public WsParam[] getParams()
      optional: reserved for future use
      Returns:
      params

    • setParams

      public void setParams(WsParam[] params1)
      optional: reserved for future use
      Parameters:
      params1 -

    • getPageIsCursor

      public String getPageIsCursor()
      Returns:
      the pageIsCursor

    • setPageIsCursor

      public void setPageIsCursor(String pageIsCursor1)
      Parameters:
      pageIsCursor1 - the pageIsCursor to set

    • getPageLastCursorField

      public String getPageLastCursorField()
      Returns:
      the pageLastCursorField

    • setPageLastCursorField

      public void setPageLastCursorField(String pageLastCursorField1)
      Parameters:
      pageLastCursorField1 - the pageLastCursorField to set

    • getPageLastCursorFieldType

      public String getPageLastCursorFieldType()
      Returns:
      the pageLastCursorFieldType

    • setPageLastCursorFieldType

      public void setPageLastCursorFieldType(String pageLastCursorFieldType1)
      Parameters:
      pageLastCursorFieldType1 - the pageLastCursorFieldType to set

    • getPageCursorFieldIncludesLastRetrieved

      public String getPageCursorFieldIncludesLastRetrieved()
      Returns:
      the pageCursorFieldIncludesLastRetrieved

    • setPageCursorFieldIncludesLastRetrieved

      public void setPageCursorFieldIncludesLastRetrieved(String pageCursorFieldIncludesLastRetrieved1)
      Parameters:
      pageCursorFieldIncludesLastRetrieved1 - the pageCursorFieldIncludesLastRetrieved to set