Class WsRestFindAttributeDefsRequest
java.lang.Object
edu.internet2.middleware.grouper.ws.rest.attribute.WsRestFindAttributeDefsRequest
- All Implemented Interfaces:
WsRequestBean
request bean in body of rest request
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionif acting as someone elseascending or null for ascending, F for descending.is the version of the client.page number 1 indexed if paging on a sort filter or parentpage size if paging on a sort filter or parentWsParam[]
optional: reserved for future useprivilege name to be checked for the logged in user or for actAsSubjectLookupgetScope()
search string with % as wildcards will search name, display name, descriptionmust be an hql query field, e.g.splitScope T or F, if T will split the scope by whitespace, and find attribute def names with each token.subject if looking for privileges or service rolefind attribute defs based on these lookupssee which http method this is supposed to be associated with, and override whatever was passed invoid
setActAsSubjectLookup
(WsSubjectLookup actAsSubjectLookup1) if acting as someone elsevoid
setAscending
(String ascending1) ascending or null for ascending, F for descending.void
setClientVersion
(String clientVersion1) is the version of the client.void
setFindByUuidOrName
(String findByUuidOrName1) void
setPageCursorFieldIncludesLastRetrieved
(String pageCursorFieldIncludesLastRetrieved1) void
setPageIsCursor
(String pageIsCursor1) void
setPageLastCursorField
(String pageLastCursorField1) void
setPageLastCursorFieldType
(String pageLastCursorFieldType1) void
setPageNumber
(String pageNumber1) page number 1 indexed if paging on a sort filter or parentvoid
setPageSize
(String pageSize1) page size if paging on a sort filter or parentvoid
optional: reserved for future usevoid
setParentStemId
(String parentStemId1) void
setPrivilegeName
(String privilegeName1) privilege name to be checked for the logged in user or for actAsSubjectLookupvoid
search string with % as wildcards will search name, display name, descriptionvoid
setSortString
(String sortString1) must be an hql query field, e.g.void
setSplitScope
(String splitScope1) splitScope T or F, if T will split the scope by whitespace, and find attribute def names with each token.void
setStemScope
(String stemScope1) void
setSubjectLookup
(WsSubjectLookup subjectLookup1) subject if looking for privileges or service rolevoid
setWsAttributeDefLookups
(WsAttributeDefLookup[] wsAttributeDefLookups1) find attribute defs based on these lookups
-
Constructor Details
-
WsRestFindAttributeDefsRequest
public WsRestFindAttributeDefsRequest()
-
-
Method Details
-
getSubjectLookup
subject if looking for privileges or service role- Returns:
- subject
-
setSubjectLookup
subject if looking for privileges or service role- Parameters:
subjectLookup1
-
-
getPrivilegeName
privilege name to be checked for the logged in user or for actAsSubjectLookup- Returns:
- privilegeName
-
setPrivilegeName
privilege name to be checked for the logged in user or for actAsSubjectLookup- Parameters:
privilegeName1
-
-
getScope
search string with % as wildcards will search name, display name, description- Returns:
- the scope
-
setScope
search string with % as wildcards will search name, display name, description- Parameters:
scope1
- the scope to set
-
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
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
- Returns:
- the stemScope
-
setStemScope
- Parameters:
stemScope1
- the stemScope to set
-
getParentStemId
- Returns:
- the parentStemId
-
setParentStemId
- Parameters:
parentStemId1
- the parentStemId to set
-
getWsAttributeDefLookups
find attribute defs based on these lookups- Returns:
- the wsAttributeDefLookups
-
setWsAttributeDefLookups
find attribute defs based on these lookups- Parameters:
wsAttributeDefLookups1
- the wsAttributeDefLookup to set
-
getPageSize
page size if paging on a sort filter or parent- Returns:
- the pageSize
-
setPageSize
page size if paging on a sort filter or parent- Parameters:
pageSize1
- the pageSize to set
-
getPageNumber
page number 1 indexed if paging on a sort filter or parent- Returns:
- the pageNumber
-
setPageNumber
page number 1 indexed if paging on a sort filter or parent- Parameters:
pageNumber1
- the pageNumber to set
-
getSortString
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Returns:
- the sortString
-
setSortString
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Parameters:
sortString1
- the sortString to set
-
getAscending
ascending or null for ascending, F for descending.- Returns:
- the ascending
-
setAscending
ascending or null for ascending, F for descending.- Parameters:
ascending1
- the ascending to set
-
getFindByUuidOrName
- Returns:
- the findByUuidOrName
-
setFindByUuidOrName
- Parameters:
findByUuidOrName1
- the findByUuidOrName to set
-
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 interfaceWsRequestBean
- Returns:
- the method
- See Also:
-
getClientVersion
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000- Returns:
- version
-
setClientVersion
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000- Parameters:
clientVersion1
-
-
getActAsSubjectLookup
if acting as someone else- Returns:
- act as subject
-
setActAsSubjectLookup
if acting as someone else- Parameters:
actAsSubjectLookup1
-
-
getParams
optional: reserved for future use- Returns:
- params
-
setParams
optional: reserved for future use- Parameters:
params1
-
-
getPageIsCursor
- Returns:
- the pageIsCursor
-
setPageIsCursor
- Parameters:
pageIsCursor1
- the pageIsCursor to set
-
getPageLastCursorField
- Returns:
- the pageLastCursorField
-
setPageLastCursorField
- Parameters:
pageLastCursorField1
- the pageLastCursorField to set
-
getPageLastCursorFieldType
- Returns:
- the pageLastCursorFieldType
-
setPageLastCursorFieldType
- Parameters:
pageLastCursorFieldType1
- the pageLastCursorFieldType to set
-
getPageCursorFieldIncludesLastRetrieved
- Returns:
- the pageCursorFieldIncludesLastRetrieved
-
setPageCursorFieldIncludesLastRetrieved
- Parameters:
pageCursorFieldIncludesLastRetrieved1
- the pageCursorFieldIncludesLastRetrieved to set
-