Class WsRestFindAttributeDefNamesRequest
java.lang.Object
edu.internet2.middleware.grouperClient.ws.beans.WsRestFindAttributeDefNamesRequest
- 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.where can the attribute definition be assigned, e.g.type of attribute definition, e.g.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 usegetScope()
search string with % as wildcards will search name, display name, descriptionfrom ServiceRole enum, which service role you are querying e.g.must 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 names associated with this attribute definitionif you want to just pass in a list of uuids and/or names.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.void
setActAsSubjectLookup
(WsSubjectLookup actAsSubjectLookup1) if acting as someone elsevoid
setAscending
(String ascending1) ascending or null for ascending, F for descending.void
setAttributeAssignType
(String attributeAssignType1) where can the attribute definition be assigned, e.g.void
setAttributeDefType
(String attributeDefType1) type of attribute definition, e.g.void
setClientVersion
(String clientVersion1) is the version of the client.void
setPageCursorFieldIncludesLastRetrieved
(String pageCursorFieldIncludesLastRetrieved) void
setPageIsCursor
(String pageIsCursor) void
setPageLastCursorField
(String pageLastCursorField) void
setPageLastCursorFieldType
(String pageLastCursorFieldType) 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
search string with % as wildcards will search name, display name, descriptionvoid
setServiceRole
(String serviceRole1) from ServiceRole enum, which service role you are querying e.g.void
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
setSubjectLookup
(WsSubjectLookup subjectLookup1) subject if looking for privileges or service rolevoid
setWsAttributeDefLookup
(WsAttributeDefLookup wsAttributeDefLookup1) find names associated with this attribute definitionvoid
setWsAttributeDefNameLookups
(WsAttributeDefNameLookup[] wsAttributeDefNameLookups1) if you want to just pass in a list of uuids and/or names.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.
-
Constructor Details
-
WsRestFindAttributeDefNamesRequest
public WsRestFindAttributeDefNamesRequest()
-
-
Method Details
-
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
-
getWsAttributeDefLookup
find names associated with this attribute definition- Returns:
- the wsAttributeDefLookup
-
setWsAttributeDefLookup
find names associated with this attribute definition- Parameters:
wsAttributeDefLookup1
- the wsAttributeDefLookup to set
-
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
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
type of attribute definition, e.g. attr, domain, limit, perm, type- Returns:
- the attributeDefType
-
setAttributeDefType
type of attribute definition, e.g. attr, domain, limit, perm, type- Parameters:
attributeDefType1
- the attributeDefType to set
-
getWsAttributeDefNameLookups
if you want to just pass in a list of uuids and/or names.- Returns:
- the wsAttributeDefNameLookups
-
setWsAttributeDefNameLookups
if you want to just pass in a list of uuids and/or names.- Parameters:
wsAttributeDefNameLookups1
- the wsAttributeDefNameLookups 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
-
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
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
-
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
-
-
getServiceRole
from ServiceRole enum, which service role you are querying e.g. admin or user- Returns:
- service role
-
getSubjectLookup
subject if looking for privileges or service role- Returns:
- subject
-
setServiceRole
from ServiceRole enum, which service role you are querying e.g. admin or user- Parameters:
serviceRole1
-
-
setSubjectLookup
subject if looking for privileges or service role- Parameters:
subjectLookup1
-
-
getPageIsCursor
- Returns:
- the pageIsCursor
-
setPageIsCursor
- Parameters:
pageIsCursor
- the pageIsCursor to set
-
getPageLastCursorField
- Returns:
- the pageLastCursorField
-
setPageLastCursorField
- Parameters:
pageLastCursorField
- the pageLastCursorField to set
-
getPageLastCursorFieldType
- Returns:
- the pageLastCursorFieldType
-
setPageLastCursorFieldType
- Parameters:
pageLastCursorFieldType
- the pageLastCursorFieldType to set
-
getPageCursorFieldIncludesLastRetrieved
- Returns:
- the pageCursorFieldIncludesLastRetrieved
-
setPageCursorFieldIncludesLastRetrieved
- Parameters:
pageCursorFieldIncludesLastRetrieved
- the pageCursorFieldIncludesLastRetrieved to set
-