Class GcFindAttributeDefs
java.lang.Object
edu.internet2.middleware.grouperClient.api.GcFindAttributeDefs
class to run find attributeDefs
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddAttributeDefIdIndex
(Long theAttributeDefIdIndex) set the AttributeDef id indexaddAttributeDefName
(String theAttributeDefName) set the AttributeDef nameaddAttributeDefUuid
(String theAttributeDefUuid) set the AttributeDef 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 sortingassignClientVersion
(String theClientVersion) assign client versionassignPageCursorFieldIncludesLastRetrieved
(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 pagingassignPrivilege
(String thePrivilegeName) assign privilege nameassignScope
(String theScope) search string with % as wildcards will search name, display name, descriptionassignSortString
(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 defs with each token.assignWsEndpoint
(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
-
GcFindAttributeDefs
public GcFindAttributeDefs()
-
-
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
-
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 defs 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
-
assignPrivilege
assign privilege name- Parameters:
privilegeName
-- Returns:
- this
-
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 GcFindAttributeDefs 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
-
addAttributeDefName
set the AttributeDef name- Parameters:
theAttributeDefName
-- Returns:
- this for chaining
-
addAttributeDefUuid
set the AttributeDef uuid- Parameters:
theAttributeDefUuid
-- Returns:
- this for chaining
-
addAttributeDefIdIndex
set the AttributeDef id index- Parameters:
theAttributeDefIdIndex
-- Returns:
- this for chaining
-