Class GcGetSubjects
java.lang.Object
edu.internet2.middleware.grouperClient.api.GcGetSubjects
class to run a get subjects web service call
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionadd a param to the listadd a param to the listaddSourceId
(String sourceId) add a source id to filter by (or none for all sources)addSubjectAttributeName
(String subjectAttributeName) addWsSubjectLookup
(WsSubjectLookup wsSubjectLookup) set the subject lookupassignActAsSubject
(WsSubjectLookup theActAsSubject) assign the act as subject if anyassignClientVersion
(String theClientVersion) assign client versionassignFieldName
(String theFieldName) assign the field name to the requestassignGroupLookup
(WsGroupLookup theGroupLookup) assign a group to filter subjects fromassignIncludeGroupDetail
(Boolean theIncludeGroupDetail) assign if the group detail should be includedassignIncludeSubjectDetail
(Boolean theIncludeSubjectDetail) if should include subject detailassignMemberFilter
(WsMemberFilter theMemberFilter) assign the member filterassignSearchString
(String theSearchString) assign the search stringassignWsEndpoint
(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
-
GcGetSubjects
public GcGetSubjects()
-
-
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
-
assignSearchString
assign the search string- Parameters:
theSearchString
-- Returns:
- this for chaining
-
assignGroupLookup
assign a group to filter subjects from- Parameters:
theGroupLookup
-- Returns:
- this for chaining
-
assignClientVersion
assign client version- Parameters:
theClientVersion
-- Returns:
- this for chaining
-
addWsSubjectLookup
set the subject lookup- Parameters:
wsSubjectLookup
-- 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
-
assignMemberFilter
assign the member filter- Parameters:
theMemberFilter
-- Returns:
- this for chaining
-
assignActAsSubject
assign the act as subject if any- Parameters:
theActAsSubject
-- Returns:
- this for chaining
-
assignFieldName
assign the field name to the request- Parameters:
theFieldName
-- Returns:
- this for chaining
-
addSourceId
add a source id to filter by (or none for all sources)- Parameters:
sourceId
-- Returns:
- this for chaining
-
addSubjectAttributeName
- Parameters:
subjectAttributeName
-- Returns:
- this for chaining
-
assignIncludeGroupDetail
assign if the group detail should be included- Parameters:
theIncludeGroupDetail
-- Returns:
- this for chaining
-
assignIncludeSubjectDetail
if should include subject detail- Parameters:
theIncludeSubjectDetail
-- Returns:
- this for chaining
-
execute
execute the call and return the results. If there is a problem calling the service, an exception will be thrown- Returns:
- the results
-