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

Class WsRestFindAttributeDefsRequest

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

  • Constructor Details

    • WsRestFindAttributeDefsRequest

      public WsRestFindAttributeDefsRequest()

  • 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 -

    • getPrivilegeName

      public String getPrivilegeName()
      privilege name to be checked for the logged in user or for actAsSubjectLookup
      Returns:
      privilegeName

    • setPrivilegeName

      public void setPrivilegeName(String privilegeName1)
      privilege name to be checked for the logged in user or for actAsSubjectLookup
      Parameters:
      privilegeName1 -

    • 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

    • getStemScope

      public String getStemScope()
      Returns:
      the stemScope

    • setStemScope

      public void setStemScope(String stemScope1)
      Parameters:
      stemScope1 - the stemScope to set

    • getParentStemId

      public String getParentStemId()
      Returns:
      the parentStemId

    • setParentStemId

      public void setParentStemId(String parentStemId1)
      Parameters:
      parentStemId1 - the parentStemId to set

    • getWsAttributeDefLookups

      public WsAttributeDefLookup[] getWsAttributeDefLookups()
      find attribute defs based on these lookups
      Returns:
      the wsAttributeDefLookups

    • setWsAttributeDefLookups

      public void setWsAttributeDefLookups(WsAttributeDefLookup[] wsAttributeDefLookups1)
      find attribute defs based on these lookups
      Parameters:
      wsAttributeDefLookups1 - the wsAttributeDefLookup 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

    • getFindByUuidOrName

      public String getFindByUuidOrName()
      Returns:
      the findByUuidOrName

    • setFindByUuidOrName

      public void setFindByUuidOrName(String findByUuidOrName1)
      Parameters:
      findByUuidOrName1 - the findByUuidOrName 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