Class WsRestGetSubjectsRequest
java.lang.Object
edu.internet2.middleware.grouper.ws.rest.subject.WsRestGetSubjectsRequest
- All Implemented Interfaces:
WsRequestBean
bean that will be the data from rest request
- See Also:
-
for method
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionsubject to act as instead of logged in useris the version of the client.is if the memberships should be retrieved from a certain field membership of the group (certain list)T or F as to if the group detail should be returnedT|F, for if the extended subject information should be returned (anything more than just the id)must be one of All, Effective, Immediate, Composite, NonImmediateWsParam[]
optional: reserved for future usesearch sources with this free-form search stringString[]
sourceIds are sources to look in for memberships, or null if allString[]
are the additional subject attributes (data) to return.returned subjects must be in this groupare subjects to look insee which http method this is supposed to be associated with, and override whatever was passed invoid
setActAsSubjectLookup
(WsSubjectLookup actAsSubjectLookup1) subject to act as instead of logged in uservoid
setClientVersion
(String clientVersion1) is the version of the client.void
setFieldName
(String fieldName1) is if the memberships should be retrieved from a certain field membership of the group (certain list)void
setIncludeGroupDetail
(String includeGroupDetail1) T or F as to if the group detail should be returnedvoid
setIncludeSubjectDetail
(String includeSubjectDetail1) T|F, for if the extended subject information should be returned (anything more than just the id)void
setMemberFilter
(String replaceAllExisting1) must be one of All, Effective, Immediate, Composite, NonImmediatevoid
optional: reserved for future usevoid
setSearchString
(String searchString1) search sources with this free-form search stringvoid
setSourceIds
(String[] sourceIds1) sourceIds are sources to look in for memberships, or null if allvoid
setSubjectAttributeNames
(String[] subjectAttributeNames1) are the additional subject attributes (data) to return.void
setWsGroupLookup
(WsGroupLookup wsGroupLookup1) returned subjects must be in this groupvoid
setWsSubjectLookups
(WsSubjectLookup[] wsSubjectLookups1) are subjects to look in
-
Constructor Details
-
WsRestGetSubjectsRequest
public WsRestGetSubjectsRequest()
-
-
Method Details
-
getWsSubjectLookups
are subjects to look in- Returns:
- subjects
-
setWsSubjectLookups
are subjects to look in- Parameters:
wsSubjectLookups1
-
-
getSourceIds
sourceIds are sources to look in for memberships, or null if all- Returns:
- the sourceIds
-
setSourceIds
sourceIds are sources to look in for memberships, or null if all- Parameters:
sourceIds1
- the sourceIds to set
-
getClientVersion
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000- Returns:
- the clientVersion
-
setClientVersion
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000- Parameters:
clientVersion1
- the clientVersion to set
-
getWsGroupLookup
returned subjects must be in this group- Returns:
- the wsGroupLookup
-
setWsGroupLookup
returned subjects must be in this group- Parameters:
wsGroupLookup1
- the wsGroupLookup to set
-
getMemberFilter
must be one of All, Effective, Immediate, Composite, NonImmediate- Returns:
- the replaceAllExisting
-
setMemberFilter
must be one of All, Effective, Immediate, Composite, NonImmediate- Parameters:
replaceAllExisting1
- the replaceAllExisting to set
-
getActAsSubjectLookup
subject to act as instead of logged in user- Returns:
- the actAsSubjectLookup
-
setActAsSubjectLookup
subject to act as instead of logged in user- Parameters:
actAsSubjectLookup1
- the actAsSubjectLookup to set
-
getFieldName
is if the memberships should be retrieved from a certain field membership of the group (certain list)- Returns:
- the fieldName
-
setFieldName
is if the memberships should be retrieved from a certain field membership of the group (certain list)- Parameters:
fieldName1
- the fieldName to set
-
getIncludeGroupDetail
T or F as to if the group detail should be returned- Returns:
- the includeGroupDetail
-
setIncludeGroupDetail
T or F as to if the group detail should be returned- Parameters:
includeGroupDetail1
- the includeGroupDetail to set
-
getIncludeSubjectDetail
T|F, for if the extended subject information should be returned (anything more than just the id)- Returns:
- the includeSubjectDetail
-
setIncludeSubjectDetail
T|F, for if the extended subject information should be returned (anything more than just the id)- Parameters:
includeSubjectDetail1
- the includeSubjectDetail to set
-
getSubjectAttributeNames
are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent- Returns:
- the subjectAttributeNames
-
setSubjectAttributeNames
are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent- Parameters:
subjectAttributeNames1
- the subjectAttributeNames to set
-
getParams
optional: reserved for future use- Returns:
- the params
-
setParams
optional: reserved for future use- Parameters:
params1
- the params 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:
-
getSearchString
search sources with this free-form search string- Returns:
- search string
-
setSearchString
search sources with this free-form search string- Parameters:
searchString1
-
-