Class GcFindAttributeDefNames
java.lang.Object
edu.internet2.middleware.grouperClient.api.GcFindAttributeDefNames
class to run find attributeDefNames
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddAttributeDefNameIdIndex
(Long theAttributeDefNameIdIndex) set the AttributeDefName id indexaddAttributeDefNameName
(String theAttributeDefNameName) set the AttributeDefName nameaddAttributeDefNameUuid
(String theAttributeDefNameUuid) set the AttributeDefName uuidadd a param to the listadd a param to the listassignActAsSubject
(WsSubjectLookup theActAsSubject) assign the act as subject if anyassignAscending
(Boolean isAscending) assign if ascending if sortingassignAttributeAssignType
(String theAttributeAssignType) where can the attribute definition be assigned, e.g.assignAttributeDefType
(String theAttributeDefType) type of attribute definition, e.g.assignClientVersion
(String theClientVersion) assign client versionassignIdIndexOfAttributeDef
(Long theIdIndexOfAttributeDef) set the AttributeDef id indexassignInheritanceSetRelation
(String theInheritanceRelation) 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.assignNameOfAttributeDef
(String theNameOfAttributeDef) set the AttributeDef nameassignPageCursorFieldIncludesLastRetrieved
(Boolean pageCursorFieldIncludesLastRetrieved) should the last retrieved item be included again in the current result setassignPageIsCursor
(Boolean pageIsCursor) T for when pagination is of cursor type.assignPageLastCursorField
(String pageLastCursorField) value of last cursor fieldassignPageLastCursorFieldType
(String pageLastCursorFieldType) type of last cursor field (string, int, long, date, timestamp)assignPageNumber
(Integer thePageNumber) assign page number if pagingassignPageSize
(Integer thePageSize) assign page size if pagingassignScope
(String theScope) search string with % as wildcards will search name, display name, descriptionassignServiceRole
(String theServiceRole) serviceRole to filter attributes that a user has a certain roleassignSortString
(String theSortString) assign sort string if sorting, e.g.assignSplitScope
(Boolean theSplitScope) T or F, if T will split the scope by whitespace, and find attribute def names with each token.assignSubjectLookup
(WsSubjectLookup theSubjectLookup) subject lookup if looking for privileges or service roleassignUuidOfAttributeDef
(String theUuidOfAttributeDef) set the AttributeDef uuidassignWsEndpoint
(String theWsEndpoint) endpoint to grouper WS, e.g.assignWsPass
(String theWsPass) ws passassignWsPassEncrypted
(String theWsPassEncrypted) ws passassignWsPassFile
(File theFile) ws passassignWsPassFileEncrypted
(File theFile) ws passassignWsUser
(String theWsUser) ws userexecute()
execute the call and return the results.
-
Constructor Details
-
GcFindAttributeDefNames
public GcFindAttributeDefNames()
-
-
Method Details
-
assignWsEndpoint
endpoint to grouper WS, e.g. https://server.school.edu/grouper-ws/servicesRest- Parameters:
theWsEndpoint
-- Returns:
- this for chaining
-
assignWsUser
ws user- Parameters:
theWsUser
-- Returns:
- this for chaining
-
assignWsPass
ws pass- Parameters:
theWsPass
-- Returns:
- this for chaining
-
assignWsPassEncrypted
ws pass- Parameters:
theWsPass
-- Returns:
- this for chaining
-
assignWsPassFile
ws pass- Parameters:
theWsPass
-- Returns:
- this for chaining
-
assignWsPassFileEncrypted
ws pass- Parameters:
theWsPass
-- Returns:
- this for chaining
-
assignServiceRole
serviceRole to filter attributes that a user has a certain role- Parameters:
theServiceRole
-- Returns:
- this for chaining
-
assignSubjectLookup
subject lookup if looking for privileges or service role- Parameters:
theSubjectLookup
-- Returns:
- this for chaining
-
assignInheritanceSetRelation
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:
theInheritanceRelation
-- Returns:
- inheritance relation
-
assignAttributeDefType
type of attribute definition, e.g. attr, domain, limit, perm, type- Parameters:
theAttributeDefType
-- Returns:
- this for chaining
-
assignAttributeAssignType
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:
theAttributeAssignType
-- Returns:
- this for chaining
-
assignScope
search string with % as wildcards will search name, display name, description- Parameters:
theScope
-- Returns:
- scope
-
assignSplitScope
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:
theSplitScope
-- Returns:
- the split scope
-
assignClientVersion
assign client version- Parameters:
theClientVersion
-- Returns:
- this for chaining
-
addParam
add a param to the list- Parameters:
paramName
-paramValue
-- Returns:
- this for chaining
-
addParam
add a param to the list- Parameters:
wsParam
-- Returns:
- this for chaining
-
assignActAsSubject
assign the act as subject if any- Parameters:
theActAsSubject
-- Returns:
- this for chaining
-
assignAscending
assign if ascending if sorting- Parameters:
isAscending
-- Returns:
- this for paging
-
assignPageNumber
assign page number if paging- Parameters:
thePageNumber
-- Returns:
- this for chaining
-
assignPageSize
assign page size if paging- Parameters:
thePageSize
-- Returns:
- this for chaining
-
assignSortString
assign sort string if sorting, e.g. can sort on name, displayName, extension, displayExtension- Parameters:
theSortString
-- Returns:
- the sort string
-
assignPageIsCursor
T for when pagination is of cursor type. F or null otherwise- Parameters:
pageIsCursor
-- Returns:
-
assignPageLastCursorField
value of last cursor field- Parameters:
pageLastCursorField
-- Returns:
-
assignPageLastCursorFieldType
type of last cursor field (string, int, long, date, timestamp)- Parameters:
pageLastCursorFieldType
-- Returns:
-
assignPageCursorFieldIncludesLastRetrieved
public GcFindAttributeDefNames assignPageCursorFieldIncludesLastRetrieved(Boolean pageCursorFieldIncludesLastRetrieved) should the last retrieved item be included again in the current result set- Parameters:
pageCursorFieldIncludesLastRetrieved
-- Returns:
-
execute
execute the call and return the results. If there is a problem calling the service, an exception will be thrown- Returns:
- the results
-
addAttributeDefNameName
set the AttributeDefName name- Parameters:
theAttributeDefNameName
-- Returns:
- this for chaining
-
addAttributeDefNameUuid
set the AttributeDefName uuid- Parameters:
theAttributeDefNameUuid
-- Returns:
- this for chaining
-
addAttributeDefNameIdIndex
set the AttributeDefName id index- Parameters:
theAttributeDefNameIdIndex
-- Returns:
- this for chaining
-
assignNameOfAttributeDef
set the AttributeDef name- Parameters:
theNameOfAttributeDef
-- Returns:
- this for chaining
-
assignUuidOfAttributeDef
set the AttributeDef uuid- Parameters:
theUuidOfAttributeDef
-- Returns:
- this for chaining
-
assignIdIndexOfAttributeDef
set the AttributeDef id index- Parameters:
theIdIndexOfAttributeDef
-- Returns:
- this for chaining
-