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

Class WsRestGetSubjectsLiteRequest

java.lang.Object

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

All Implemented Interfaces:

WsRequestBean

public class WsRestGetSubjectsLiteRequest
extends java.lang.Object
implements WsRequestBean

request bean for rest get subjects lite request

Constructor Summary

Constructors

Constructor and Description
WsRestGetSubjectsLiteRequest()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActAsSubjectId() actAsSubjectId subject to act as instead of logged in user
java.lang.String	getActAsSubjectIdentifier() actAsSubjectIdentifier subject to act as instead of logged in user
java.lang.String	getActAsSubjectSourceId() actAsSubjectSource subject to act as instead of logged in user
java.lang.String	getClientVersion() field 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	getGroupName() group name to look in
java.lang.String	getGroupUuid() group uuid to look in
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
java.lang.String	getParamName0() paramName0 optional: reserved for future use
java.lang.String	getParamName1() paramName1 optional: reserved for future use
java.lang.String	getParamValue0() paramValue0 optional: reserved for future use
java.lang.String	getParamValue1() paramValue1 optional: reserved for future use
java.lang.String	getRetrieveSubjectDetail() retrieveSubjectDetail
java.lang.String	getSearchString() search sources with this free-form search string
java.lang.String	getSourceIds() sourceids to limit request to, or null for all
java.lang.String	getSubjectAttributeNames() subjectAttributeNames
java.lang.String	getSubjectId() subject id to look for memberships
java.lang.String	getSubjectIdentifier() subject id to look for memberships
java.lang.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(java.lang.String actAsSubjectId1) actAsSubjectId subject to act as instead of logged in user
void	setActAsSubjectIdentifier(java.lang.String actAsSubjectIdentifier1) actAsSubjectIdentifier subject to act as instead of logged in user
void	setActAsSubjectSourceId(java.lang.String actAsSubjectSource1) actAsSubjectSource subject to act as instead of logged in user
void	setClientVersion(java.lang.String clientVersion1) field 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	setGroupName(java.lang.String groupName1) group name to look in
void	setGroupUuid(java.lang.String groupUuid1) group uuid to look in
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	setParamName0(java.lang.String _paramName0) paramName0 optional: reserved for future use
void	setParamName1(java.lang.String _paramName1) paramName1 optional: reserved for future use
void	setParamValue0(java.lang.String _paramValue0) _paramValue0 optional: reserved for future use
void	setParamValue1(java.lang.String _paramValue1) paramValue1 optional: reserved for future use
void	setRetrieveSubjectDetail(java.lang.String retrieveSubjectDetail1) retrieveSubjectDetail1
void	setSearchString(java.lang.String searchString1) search sources with this free-form search string
void	setSourceIds(java.lang.String sourceIds1) sourceids to limit request to, or null for all
void	setSubjectAttributeNames(java.lang.String subjectAttributeNames1) subjectAttributeNames
void	setSubjectId(java.lang.String subjectId1) subject id to look for memberships
void	setSubjectIdentifier(java.lang.String subjectIdentifier1) subject id to look for memberships
void	setSubjectSourceId(java.lang.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 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 -

getSubjectId

public java.lang.String getSubjectId()

subject id to look for memberships

Returns:

subject id

setSubjectId

public void setSubjectId(java.lang.String subjectId1)

subject id to look for memberships

Parameters:

subjectId1 -

getSubjectIdentifier

public java.lang.String getSubjectIdentifier()

subject id to look for memberships

Returns:

subject identifier

setSubjectIdentifier

public void setSubjectIdentifier(java.lang.String subjectIdentifier1)

subject id to look for memberships

Parameters:

subjectIdentifier1 -

getSubjectSourceId

public java.lang.String getSubjectSourceId()

subject id to look for memberships

Returns:

source id

setSubjectSourceId

public void setSubjectSourceId(java.lang.String subjectSourceId1)

subject id to look for memberships

Parameters:

subjectSourceId1 -

getSourceIds

public java.lang.String getSourceIds()

sourceids to limit request to, or null for all

Returns:

the sourceIds

setSourceIds

public void setSourceIds(java.lang.String sourceIds1)

sourceids to limit request to, or null for all

Parameters:

sourceIds1 - the sourceIds to set

getRetrieveSubjectDetail

public java.lang.String getRetrieveSubjectDetail()

retrieveSubjectDetail

Returns:

retrieveSubjectDetail

setRetrieveSubjectDetail

public void setRetrieveSubjectDetail(java.lang.String retrieveSubjectDetail1)

retrieveSubjectDetail1

Parameters:

retrieveSubjectDetail1 -

getActAsSubjectId

public java.lang.String getActAsSubjectId()

actAsSubjectId subject to act as instead of logged in user

Returns:

actAsSubjectId

setActAsSubjectId

public void setActAsSubjectId(java.lang.String actAsSubjectId1)

actAsSubjectId subject to act as instead of logged in user

Parameters:

actAsSubjectId1 -

getActAsSubjectSourceId

public java.lang.String getActAsSubjectSourceId()

actAsSubjectSource subject to act as instead of logged in user

Returns:

actAsSubjectSource

setActAsSubjectSourceId

public void setActAsSubjectSourceId(java.lang.String actAsSubjectSource1)

actAsSubjectSource subject to act as instead of logged in user

Parameters:

actAsSubjectSource1 -

getActAsSubjectIdentifier

public java.lang.String getActAsSubjectIdentifier()

actAsSubjectIdentifier subject to act as instead of logged in user

Returns:

actAsSubjectIdentifier

setActAsSubjectIdentifier

public void setActAsSubjectIdentifier(java.lang.String actAsSubjectIdentifier1)

actAsSubjectIdentifier subject to act as instead of logged in user

Parameters:

actAsSubjectIdentifier1 -

getSubjectAttributeNames

public java.lang.String getSubjectAttributeNames()

subjectAttributeNames

Returns:

subjectAttributeNames

setSubjectAttributeNames

public void setSubjectAttributeNames(java.lang.String subjectAttributeNames1)

subjectAttributeNames

Parameters:

subjectAttributeNames1 -

getIncludeGroupDetail

public java.lang.String getIncludeGroupDetail()

T or F as to if the group detail should be returned

Returns:

includeGroupDetail

setIncludeGroupDetail

public void setIncludeGroupDetail(java.lang.String includeGroupDetail1)

T or F as to if the group detail should be returned

Parameters:

includeGroupDetail1 -

getParamName0

public java.lang.String getParamName0()

paramName0 optional: reserved for future use

Returns:

paramName0

setParamName0

public void setParamName0(java.lang.String _paramName0)

paramName0 optional: reserved for future use

Parameters:

_paramName0 -

getParamValue0

public java.lang.String getParamValue0()

paramValue0 optional: reserved for future use

Returns:

paramValue0

setParamValue0

public void setParamValue0(java.lang.String _paramValue0)

_paramValue0 optional: reserved for future use

Parameters:

_paramValue0 -

getParamName1

public java.lang.String getParamName1()

paramName1 optional: reserved for future use

Returns:

paramName1

setParamName1

public void setParamName1(java.lang.String _paramName1)

paramName1 optional: reserved for future use

Parameters:

_paramName1 -

getParamValue1

public java.lang.String getParamValue1()

paramValue1 optional: reserved for future use

Returns:

paramValue1

setParamValue1

public void setParamValue1(java.lang.String _paramValue1)

paramValue1 optional: reserved for future use

Parameters:

_paramValue1 -

getGroupName

public java.lang.String getGroupName()

group name to look in

Returns:

the groupName

setGroupName

public void setGroupName(java.lang.String groupName1)

group name to look in

Parameters:

groupName1 - the groupName to set

getGroupUuid

public java.lang.String getGroupUuid()

group uuid to look in

Returns:

the groupUuid

setGroupUuid

public void setGroupUuid(java.lang.String groupUuid1)

group uuid to look in

Parameters:

groupUuid1 - the groupUuid to set

getClientVersion

public java.lang.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(java.lang.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 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

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

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