WsRestFindAttributeDefsRequest

java.lang.Object
- edu.internet2.middleware.grouper.ws.rest.attribute.WsRestFindAttributeDefsRequest

All Implemented Interfaces:: WsRequestBean

public class WsRestFindAttributeDefsRequest
extends java.lang.Object
implements WsRequestBean

request bean in body of rest request

Constructor Summary

Constructors
Constructor and Description

WsRestFindAttributeDefsRequest()

Constructors
Constructor and Description
`WsRestFindAttributeDefsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WsSubjectLookup`	`getActAsSubjectLookup()` if acting as someone else
`java.lang.String`	`getAscending()` ascending or null for ascending, F for descending.
`java.lang.String`	`getClientVersion()` is the version of the client.
`java.lang.String`	`getFindByUuidOrName()`
`java.lang.String`	`getPageNumber()` page number 1 indexed if paging on a sort filter or parent
`java.lang.String`	`getPageSize()` page size if paging on a sort filter or parent
`WsParam[]`	`getParams()` optional: reserved for future use
`java.lang.String`	`getParentStemId()`
`java.lang.String`	`getPrivilegeName()` privilege name to be checked for the logged in user or for actAsSubjectLookup
`java.lang.String`	`getScope()` search string with % as wildcards will search name, display name, description
`java.lang.String`	`getSortString()` must be an hql query field, e.g.
`java.lang.String`	`getSplitScope()` splitScope T or F, if T will split the scope by whitespace, and find attribute def names with each token.
`java.lang.String`	`getStemScope()`
`WsSubjectLookup`	`getSubjectLookup()` subject if looking for privileges or service role
`WsAttributeDefLookup[]`	`getWsAttributeDefLookups()` find attribute defs based on these lookups
`GrouperRestHttpMethod`	`retrieveRestHttpMethod()` see which http method this is supposed to be associated with, and override whatever was passed in
`void`	`setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)` if acting as someone else
`void`	`setAscending(java.lang.String ascending1)` ascending or null for ascending, F for descending.
`void`	`setClientVersion(java.lang.String clientVersion1)` is the version of the client.
`void`	`setFindByUuidOrName(java.lang.String findByUuidOrName1)`
`void`	`setPageNumber(java.lang.String pageNumber1)` page number 1 indexed if paging on a sort filter or parent
`void`	`setPageSize(java.lang.String pageSize1)` page size if paging on a sort filter or parent
`void`	`setParams(WsParam[] params1)` optional: reserved for future use
`void`	`setParentStemId(java.lang.String parentStemId1)`
`void`	`setPrivilegeName(java.lang.String privilegeName1)` privilege name to be checked for the logged in user or for actAsSubjectLookup
`void`	`setScope(java.lang.String scope1)` search string with % as wildcards will search name, display name, description
`void`	`setSortString(java.lang.String sortString1)` must be an hql query field, e.g.
`void`	`setSplitScope(java.lang.String splitScope1)` splitScope T or F, if T will split the scope by whitespace, and find attribute def names with each token.
`void`	`setStemScope(java.lang.String stemScope1)`
`void`	`setSubjectLookup(WsSubjectLookup subjectLookup1)` subject if looking for privileges or service role
`void`	`setWsAttributeDefLookups(WsAttributeDefLookup[] wsAttributeDefLookups1)` find attribute defs based on these lookups

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WsRestFindAttributeDefsRequest
```
public WsRestFindAttributeDefsRequest()
```
- Method Detail
  - 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 java.lang.String getPrivilegeName()
```
    privilege name to be checked for the logged in user or for actAsSubjectLookup
    
    Returns:
    
    privilegeName
  - setPrivilegeName
```
public void setPrivilegeName(java.lang.String privilegeName1)
```
    privilege name to be checked for the logged in user or for actAsSubjectLookup
    
    Parameters:
    
    privilegeName1 -
  - getScope
```
public java.lang.String getScope()
```
    search string with % as wildcards will search name, display name, description
    
    Returns:
    
    the scope
  - setScope
```
public void setScope(java.lang.String scope1)
```
    search string with % as wildcards will search name, display name, description
    
    Parameters:
    
    scope1 - the scope to set
  - getSplitScope
```
public java.lang.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(java.lang.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 java.lang.String getStemScope()
```
    Returns:
    
    the stemScope
  - setStemScope
```
public void setStemScope(java.lang.String stemScope1)
```
    Parameters:
    
    stemScope1 - the stemScope to set
  - getParentStemId
```
public java.lang.String getParentStemId()
```
    Returns:
    
    the parentStemId
  - setParentStemId
```
public void setParentStemId(java.lang.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 java.lang.String getPageSize()
```
    page size if paging on a sort filter or parent
    
    Returns:
    
    the pageSize
  - setPageSize
```
public void setPageSize(java.lang.String pageSize1)
```
    page size if paging on a sort filter or parent
    
    Parameters:
    
    pageSize1 - the pageSize to set
  - getPageNumber
```
public java.lang.String getPageNumber()
```
    page number 1 indexed if paging on a sort filter or parent
    
    Returns:
    
    the pageNumber
  - setPageNumber
```
public void setPageNumber(java.lang.String pageNumber1)
```
    page number 1 indexed if paging on a sort filter or parent
    
    Parameters:
    
    pageNumber1 - the pageNumber to set
  - getSortString
```
public java.lang.String getSortString()
```
    must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension
    
    Returns:
    
    the sortString
  - setSortString
```
public void setSortString(java.lang.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 java.lang.String getAscending()
```
    ascending or null for ascending, F for descending.
    
    Returns:
    
    the ascending
  - setAscending
```
public void setAscending(java.lang.String ascending1)
```
    ascending or null for ascending, F for descending.
    
    Parameters:
    
    ascending1 - the ascending to set
  - getFindByUuidOrName
```
public java.lang.String getFindByUuidOrName()
```
    Returns:
    
    the findByUuidOrName
  - setFindByUuidOrName
```
public void setFindByUuidOrName(java.lang.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:
    
    WsRequestBean.retrieveRestHttpMethod()
  - getClientVersion
```
public java.lang.String getClientVersion()
```
    is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000
    
    Returns:
    
    version
  - setClientVersion
```
public void setClientVersion(java.lang.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 -

Class WsRestFindAttributeDefsRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WsRestFindAttributeDefsRequest

Method Detail

getSubjectLookup

setSubjectLookup

getPrivilegeName

setPrivilegeName

getScope

setScope

getSplitScope

setSplitScope

getStemScope

setStemScope

getParentStemId

setParentStemId

getWsAttributeDefLookups

setWsAttributeDefLookups

getPageSize

setPageSize

getPageNumber

setPageNumber

getSortString

setSortString

getAscending

setAscending

getFindByUuidOrName

setFindByUuidOrName

retrieveRestHttpMethod

getClientVersion

setClientVersion

getActAsSubjectLookup

setActAsSubjectLookup

getParams

setParams