edu.internet2.middleware.grouper.ws.rest.subject
Class WsRestGetSubjectsRequest

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.rest.subject.WsRestGetSubjectsRequest
All Implemented Interfaces:
WsRequestBean

public class WsRestGetSubjectsRequest
extends java.lang.Object
implements WsRequestBean

bean that will be the data from rest request

See Also:
for method

Constructor Summary
WsRestGetSubjectsRequest()
           
 
Method Summary
 WsSubjectLookup getActAsSubjectLookup()
          subject to act as instead of logged in user
 java.lang.String getClientVersion()
          is the version of the client.
 java.lang.String getFieldName()
          is if the memberships should be retrieved from a certain field membership of the group (certain list)
 java.lang.String getIncludeGroupDetail()
          T or F as to if the group detail should be returned
 java.lang.String getIncludeSubjectDetail()
          T|F, for if the extended subject information should be returned (anything more than just the id)
 java.lang.String getMemberFilter()
          must be one of All, Effective, Immediate, Composite, NonImmediate
 WsParam[] getParams()
          optional: reserved for future use
 java.lang.String getSearchString()
          search sources with this free-form search string
 java.lang.String[] getSourceIds()
          sourceIds are sources to look in for memberships, or null if all
 java.lang.String[] getSubjectAttributeNames()
          are the additional subject attributes (data) to return.
 WsGroupLookup getWsGroupLookup()
          returned subjects must be in this group
 WsSubjectLookup[] getWsSubjectLookups()
          are subjects to look in
 GrouperRestHttpMethod retrieveRestHttpMethod()
          see which http method this is supposed to be associated with, and override whatever was passed in
 void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
          subject to act as instead of logged in user
 void setClientVersion(java.lang.String clientVersion1)
          is the version of the client.
 void setFieldName(java.lang.String fieldName1)
          is if the memberships should be retrieved from a certain field membership of the group (certain list)
 void setIncludeGroupDetail(java.lang.String includeGroupDetail1)
          T or F as to if the group detail should be returned
 void setIncludeSubjectDetail(java.lang.String includeSubjectDetail1)
          T|F, for if the extended subject information should be returned (anything more than just the id)
 void setMemberFilter(java.lang.String replaceAllExisting1)
          must be one of All, Effective, Immediate, Composite, NonImmediate
 void setParams(WsParam[] params1)
          optional: reserved for future use
 void setSearchString(java.lang.String searchString1)
          search sources with this free-form search string
 void setSourceIds(java.lang.String[] sourceIds1)
          sourceIds are sources to look in for memberships, or null if all
 void setSubjectAttributeNames(java.lang.String[] subjectAttributeNames1)
          are the additional subject attributes (data) to return.
 void setWsGroupLookup(WsGroupLookup wsGroupLookup1)
          returned subjects must be in this group
 void setWsSubjectLookups(WsSubjectLookup[] wsSubjectLookups1)
          are subjects to look in
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsRestGetSubjectsRequest

public WsRestGetSubjectsRequest()
Method Detail

getWsSubjectLookups

public WsSubjectLookup[] getWsSubjectLookups()
are subjects to look in

Returns:
subjects

setWsSubjectLookups

public void setWsSubjectLookups(WsSubjectLookup[] wsSubjectLookups1)
are subjects to look in

Parameters:
wsSubjectLookups1 -

getSourceIds

public java.lang.String[] getSourceIds()
sourceIds are sources to look in for memberships, or null if all

Returns:
the sourceIds

setSourceIds

public void setSourceIds(java.lang.String[] sourceIds1)
sourceIds are sources to look in for memberships, or null if all

Parameters:
sourceIds1 - the sourceIds to set

getClientVersion

public java.lang.String getClientVersion()
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000

Returns:
the clientVersion

setClientVersion

public void setClientVersion(java.lang.String clientVersion1)
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000

Parameters:
clientVersion1 - the clientVersion to set

getWsGroupLookup

public WsGroupLookup getWsGroupLookup()
returned subjects must be in this group

Returns:
the wsGroupLookup

setWsGroupLookup

public void setWsGroupLookup(WsGroupLookup wsGroupLookup1)
returned subjects must be in this group

Parameters:
wsGroupLookup1 - the wsGroupLookup to set

getMemberFilter

public java.lang.String getMemberFilter()
must be one of All, Effective, Immediate, Composite, NonImmediate

Returns:
the replaceAllExisting

setMemberFilter

public void setMemberFilter(java.lang.String replaceAllExisting1)
must be one of All, Effective, Immediate, Composite, NonImmediate

Parameters:
replaceAllExisting1 - the replaceAllExisting to set

getActAsSubjectLookup

public WsSubjectLookup getActAsSubjectLookup()
subject to act as instead of logged in user

Returns:
the actAsSubjectLookup

setActAsSubjectLookup

public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
subject to act as instead of logged in user

Parameters:
actAsSubjectLookup1 - the actAsSubjectLookup to set

getFieldName

public java.lang.String getFieldName()
is if the memberships should be retrieved from a certain field membership of the group (certain list)

Returns:
the fieldName

setFieldName

public void setFieldName(java.lang.String fieldName1)
is if the memberships should be retrieved from a certain field membership of the group (certain list)

Parameters:
fieldName1 - the fieldName to set

getIncludeGroupDetail

public java.lang.String getIncludeGroupDetail()
T or F as to if the group detail should be returned

Returns:
the includeGroupDetail

setIncludeGroupDetail

public void setIncludeGroupDetail(java.lang.String includeGroupDetail1)
T or F as to if the group detail should be returned

Parameters:
includeGroupDetail1 - the includeGroupDetail to set

getIncludeSubjectDetail

public java.lang.String getIncludeSubjectDetail()
T|F, for if the extended subject information should be returned (anything more than just the id)

Returns:
the includeSubjectDetail

setIncludeSubjectDetail

public void setIncludeSubjectDetail(java.lang.String includeSubjectDetail1)
T|F, for if the extended subject information should be returned (anything more than just the id)

Parameters:
includeSubjectDetail1 - the includeSubjectDetail to set

getSubjectAttributeNames

public java.lang.String[] 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

public void setSubjectAttributeNames(java.lang.String[] subjectAttributeNames1)
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

public WsParam[] getParams()
optional: reserved for future use

Returns:
the params

setParams

public void setParams(WsParam[] params1)
optional: reserved for future use

Parameters:
params1 - the params to set

retrieveRestHttpMethod

public GrouperRestHttpMethod 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 interface WsRequestBean
Returns:
the method
See Also:
WsRequestBean.retrieveRestHttpMethod()

getSearchString

public java.lang.String getSearchString()
search sources with this free-form search string

Returns:
search string

setSearchString

public void setSearchString(java.lang.String searchString1)
search sources with this free-form search string

Parameters:
searchString1 -