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

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

public class WsRestGetSubjectsLiteRequest
extends Object
implements WsRequestBean

request bean for rest get subjects lite request


Constructor Summary
WsRestGetSubjectsLiteRequest()
           
 
Method Summary
 String getActAsSubjectId()
          actAsSubjectId subject to act as instead of logged in user
 String getActAsSubjectIdentifier()
          actAsSubjectIdentifier subject to act as instead of logged in user
 String getActAsSubjectSourceId()
          actAsSubjectSource subject to act as instead of logged in user
 String getClientVersion()
          field is the version of the client.
 String getFieldName()
          is if the memberships should be retrieved from a certain field membership of the group (certain list)
 String getGroupName()
          group name to look in
 String getGroupUuid()
          group uuid to look in
 String getIncludeGroupDetail()
          T or F as to if the group detail should be returned
 String getIncludeSubjectDetail()
          T|F, for if the extended subject information should be returned (anything more than just the id)
 String getMemberFilter()
          must be one of All, Effective, Immediate, Composite, NonImmediate
 String getParamName0()
          paramName0 optional: reserved for future use
 String getParamName1()
          paramName1 optional: reserved for future use
 String getParamValue0()
          paramValue0 optional: reserved for future use
 String getParamValue1()
          paramValue1 optional: reserved for future use
 String getRetrieveSubjectDetail()
          retrieveSubjectDetail
 String getSearchString()
          search sources with this free-form search string
 String getSourceIds()
          sourceids to limit request to, or null for all
 String getSubjectAttributeNames()
          subjectAttributeNames
 String getSubjectId()
          subject id to look for memberships
 String getSubjectIdentifier()
          subject id to look for memberships
 String getSubjectSourceId()
          subject id to look for memberships
 GrouperRestHttpMethod retrieveRestHttpMethod()
          see which http method this is supposed to be associated with, and override whatever was passed in
 void setActAsSubjectId(String actAsSubjectId1)
          actAsSubjectId subject to act as instead of logged in user
 void setActAsSubjectIdentifier(String actAsSubjectIdentifier1)
          actAsSubjectIdentifier subject to act as instead of logged in user
 void setActAsSubjectSourceId(String actAsSubjectSource1)
          actAsSubjectSource subject to act as instead of logged in user
 void setClientVersion(String clientVersion1)
          field 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 setGroupName(String groupName1)
          group name to look in
 void setGroupUuid(String groupUuid1)
          group uuid to look in
 void setIncludeGroupDetail(String includeGroupDetail1)
          T or F as to if the group detail should be returned
 void 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, NonImmediate
 void setParamName0(String _paramName0)
          paramName0 optional: reserved for future use
 void setParamName1(String _paramName1)
          paramName1 optional: reserved for future use
 void setParamValue0(String _paramValue0)
          _paramValue0 optional: reserved for future use
 void setParamValue1(String _paramValue1)
          paramValue1 optional: reserved for future use
 void setRetrieveSubjectDetail(String retrieveSubjectDetail1)
          retrieveSubjectDetail1
 void setSearchString(String searchString1)
          search sources with this free-form search string
 void setSourceIds(String sourceIds1)
          sourceids to limit request to, or null for all
 void setSubjectAttributeNames(String subjectAttributeNames1)
          subjectAttributeNames
 void setSubjectId(String subjectId1)
          subject id to look for memberships
 void setSubjectIdentifier(String subjectIdentifier1)
          subject id to look for memberships
 void setSubjectSourceId(String subjectSourceId1)
          subject id to look for memberships
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsRestGetSubjectsLiteRequest

public WsRestGetSubjectsLiteRequest()
Method Detail

getSearchString

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

Returns:
search string

setSearchString

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

Parameters:
searchString1 -

getSubjectId

public String getSubjectId()
subject id to look for memberships

Returns:
subject id

setSubjectId

public void setSubjectId(String subjectId1)
subject id to look for memberships

Parameters:
subjectId1 -

getSubjectIdentifier

public String getSubjectIdentifier()
subject id to look for memberships

Returns:
subject identifier

setSubjectIdentifier

public void setSubjectIdentifier(String subjectIdentifier1)
subject id to look for memberships

Parameters:
subjectIdentifier1 -

getSubjectSourceId

public String getSubjectSourceId()
subject id to look for memberships

Returns:
source id

setSubjectSourceId

public void setSubjectSourceId(String subjectSourceId1)
subject id to look for memberships

Parameters:
subjectSourceId1 -

getSourceIds

public String getSourceIds()
sourceids to limit request to, or null for all

Returns:
the sourceIds

setSourceIds

public void setSourceIds(String sourceIds1)
sourceids to limit request to, or null for all

Parameters:
sourceIds1 - the sourceIds to set

getRetrieveSubjectDetail

public String getRetrieveSubjectDetail()
retrieveSubjectDetail

Returns:
retrieveSubjectDetail

setRetrieveSubjectDetail

public void setRetrieveSubjectDetail(String retrieveSubjectDetail1)
retrieveSubjectDetail1

Parameters:
retrieveSubjectDetail1 -

getActAsSubjectId

public String getActAsSubjectId()
actAsSubjectId subject to act as instead of logged in user

Returns:
actAsSubjectId

setActAsSubjectId

public void setActAsSubjectId(String actAsSubjectId1)
actAsSubjectId subject to act as instead of logged in user

Parameters:
actAsSubjectId1 -

getActAsSubjectSourceId

public String getActAsSubjectSourceId()
actAsSubjectSource subject to act as instead of logged in user

Returns:
actAsSubjectSource

setActAsSubjectSourceId

public void setActAsSubjectSourceId(String actAsSubjectSource1)
actAsSubjectSource subject to act as instead of logged in user

Parameters:
actAsSubjectSource1 -

getActAsSubjectIdentifier

public String getActAsSubjectIdentifier()
actAsSubjectIdentifier subject to act as instead of logged in user

Returns:
actAsSubjectIdentifier

setActAsSubjectIdentifier

public void setActAsSubjectIdentifier(String actAsSubjectIdentifier1)
actAsSubjectIdentifier subject to act as instead of logged in user

Parameters:
actAsSubjectIdentifier1 -

getSubjectAttributeNames

public String getSubjectAttributeNames()
subjectAttributeNames

Returns:
subjectAttributeNames

setSubjectAttributeNames

public void setSubjectAttributeNames(String subjectAttributeNames1)
subjectAttributeNames

Parameters:
subjectAttributeNames1 -

getIncludeGroupDetail

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

Returns:
includeGroupDetail

setIncludeGroupDetail

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

Parameters:
includeGroupDetail1 -

getParamName0

public String getParamName0()
paramName0 optional: reserved for future use

Returns:
paramName0

setParamName0

public void setParamName0(String _paramName0)
paramName0 optional: reserved for future use

Parameters:
_paramName0 -

getParamValue0

public String getParamValue0()
paramValue0 optional: reserved for future use

Returns:
paramValue0

setParamValue0

public void setParamValue0(String _paramValue0)
_paramValue0 optional: reserved for future use

Parameters:
_paramValue0 -

getParamName1

public String getParamName1()
paramName1 optional: reserved for future use

Returns:
paramName1

setParamName1

public void setParamName1(String _paramName1)
paramName1 optional: reserved for future use

Parameters:
_paramName1 -

getParamValue1

public String getParamValue1()
paramValue1 optional: reserved for future use

Returns:
paramValue1

setParamValue1

public void setParamValue1(String _paramValue1)
paramValue1 optional: reserved for future use

Parameters:
_paramValue1 -

getGroupName

public String getGroupName()
group name to look in

Returns:
the groupName

setGroupName

public void setGroupName(String groupName1)
group name to look in

Parameters:
groupName1 - the groupName to set

getGroupUuid

public String getGroupUuid()
group uuid to look in

Returns:
the groupUuid

setGroupUuid

public void setGroupUuid(String groupUuid1)
group uuid to look in

Parameters:
groupUuid1 - the groupUuid to set

getClientVersion

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

Returns:
the clientVersion

setClientVersion

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

Parameters:
clientVersion1 - the clientVersion 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()

getFieldName

public 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(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

getIncludeSubjectDetail

public 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(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

getMemberFilter

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

Returns:
the replaceAllExisting

setMemberFilter

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

Parameters:
replaceAllExisting1 - the replaceAllExisting to set