edu.internet2.middleware.grouper.ws.rest.group

Class WsRestGetGroupsLiteRequest

java.lang.Object

edu.internet2.middleware.grouper.ws.rest.group.WsRestGetGroupsLiteRequest

All Implemented Interfaces:

WsRequestBean

public class WsRestGetGroupsLiteRequest
extends java.lang.Object
implements WsRequestBean

lite bean that will be the data from rest request

See Also:

for lite method

Constructor Summary

Constructors

Constructor and Description
WsRestGetGroupsLiteRequest()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActAsSubjectId()
java.lang.String	getActAsSubjectIdentifier()
java.lang.String	getActAsSubjectSourceId()
java.lang.String	getAscending() ascending or null for ascending, F for descending.
java.lang.String	getClientVersion()
java.lang.String	getEnabled() enabled is A for all, T or null for enabled only, F for disabled
java.lang.String	getFieldName() field name (list) to search, blank for members list
java.lang.String	getIncludeGroupDetail()
java.lang.String	getIncludeSubjectDetail()
java.lang.String	getMemberFilter()
java.lang.String	getPageNumber() pageNumber page number 1 indexed if paging
java.lang.String	getPageSize() pageSize page size if paging
java.lang.String	getParamName0()
java.lang.String	getParamName1()
java.lang.String	getParamValue0()
java.lang.String	getParamValue1()
java.lang.String	getPointInTimeFrom() To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo.
java.lang.String	getPointInTimeTo() To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom.
java.lang.String	getScope() scope is a DB pattern that will have % appended to it, or null for all.
java.lang.String	getSortString() sortString must be an hql query field, e.g.
java.lang.String	getStemName() is the stem to check in, or null if all.
java.lang.String	getStemScope() stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
java.lang.String	getStemUuid() is the stem to check in, or null if all.
java.lang.String	getSubjectAttributeNames()
java.lang.String	getSubjectId()
java.lang.String	getSubjectIdentifier()
java.lang.String	getSubjectSourceId()
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)
void	setActAsSubjectIdentifier(java.lang.String actAsSubjectIdentifier1)
void	setActAsSubjectSourceId(java.lang.String actAsSubjectSource1)
void	setAscending(java.lang.String ascending1) ascending or null for ascending, F for descending.
void	setClientVersion(java.lang.String clientVersion1)
void	setEnabled(java.lang.String enabled1) enabled is A for all, T or null for enabled only, F for disabled
void	setFieldName(java.lang.String fieldName1) field name (list) to search, blank for members list
void	setIncludeGroupDetail(java.lang.String includeGroupDetail1)
void	setIncludeSubjectDetail(java.lang.String includeSubjectDetail1)
void	setMemberFilter(java.lang.String fieldName1)
void	setPageNumber(java.lang.String pageNumber1) pageNumber page number 1 indexed if paging
void	setPageSize(java.lang.String pageSize1) pageSize page size if paging
void	setParamName0(java.lang.String _paramName0)
void	setParamName1(java.lang.String _paramName1)
void	setParamValue0(java.lang.String _paramValue0)
void	setParamValue1(java.lang.String _paramValue1)
void	setPointInTimeFrom(java.lang.String pointInTimeFrom1) To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo.
void	setPointInTimeTo(java.lang.String pointInTimeTo1) To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom.
void	setScope(java.lang.String scope1) scope is a DB pattern that will have % appended to it, or null for all.
void	setSortString(java.lang.String sortString1) sortString must be an hql query field, e.g.
void	setStemName(java.lang.String stemName1) is the stem to check in, or null if all.
void	setStemScope(java.lang.String stemScope1) stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
void	setStemUuid(java.lang.String stemUuid1) is the stem to check in, or null if all.
void	setSubjectAttributeNames(java.lang.String subjectAttributeNames1)
void	setSubjectId(java.lang.String subjectId1)
void	setSubjectIdentifier(java.lang.String subjectIdentifier1)
void	setSubjectSourceId(java.lang.String subjectSource1)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WsRestGetGroupsLiteRequest

public WsRestGetGroupsLiteRequest()

Method Detail

getFieldName

public java.lang.String getFieldName()

field name (list) to search, blank for members list

Returns:

field name

setFieldName

public void setFieldName(java.lang.String fieldName1)

field name (list) to search, blank for members list

Parameters:

fieldName1 -

getScope

public java.lang.String getScope()

scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:

Returns:

scope

setScope

public void setScope(java.lang.String scope1)

scope is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:

Parameters:

scope1 -

getStemUuid

public java.lang.String getStemUuid()

is the stem to check in, or null if all. If has stem, must have stemScope

Returns:

stem lookup

setStemUuid

public void setStemUuid(java.lang.String stemUuid1)

is the stem to check in, or null if all. If has stem, must have stemScope

Parameters:

stemUuid1 -

getStemName

public java.lang.String getStemName()

is the stem to check in, or null if all. If has stem, must have stemScope

Returns:

stem lookup

setStemName

public void setStemName(java.lang.String stemName1)

is the stem to check in, or null if all. If has stem, must have stemScope

Parameters:

stemName1 -

getStemScope

public java.lang.String getStemScope()

stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stem

Returns:

stem scope

setStemScope

public void setStemScope(java.lang.String stemScope1)

stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath. You must pass stemScope if you pass a stem

Parameters:

stemScope1 -

getEnabled

public java.lang.String getEnabled()

enabled is A for all, T or null for enabled only, F for disabled

Returns:

enabled string

setEnabled

public void setEnabled(java.lang.String enabled1)

enabled is A for all, T or null for enabled only, F for disabled

Parameters:

enabled1 -

getPageSize

public java.lang.String getPageSize()

pageSize page size if paging

Returns:

page size

setPageSize

public void setPageSize(java.lang.String pageSize1)

pageSize page size if paging

Parameters:

pageSize1 -

getPageNumber

public java.lang.String getPageNumber()

pageNumber page number 1 indexed if paging

Returns:

page number

setPageNumber

public void setPageNumber(java.lang.String pageNumber1)

pageNumber page number 1 indexed if paging

Parameters:

pageNumber1 -

getSortString

public java.lang.String getSortString()

sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension

Returns:

sort string

setSortString

public void setSortString(java.lang.String sortString1)

sortString must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension

Parameters:

sortString1 -

getAscending

public java.lang.String getAscending()

ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string

Returns:

if ascending

setAscending

public void setAscending(java.lang.String ascending1)

ascending or null for ascending, F for descending. If you pass T or F, must pass a sort string

Parameters:

ascending1 -

getClientVersion

public java.lang.String getClientVersion()

Returns:

field

setClientVersion

public void setClientVersion(java.lang.String clientVersion1)

Parameters:

clientVersion1 -

getSubjectId

public java.lang.String getSubjectId()

Returns:

field

setSubjectId

public void setSubjectId(java.lang.String subjectId1)

Parameters:

subjectId1 -

getSubjectSourceId

public java.lang.String getSubjectSourceId()

Returns:

field

setSubjectSourceId

public void setSubjectSourceId(java.lang.String subjectSource1)

Parameters:

subjectSource1 -

getSubjectIdentifier

public java.lang.String getSubjectIdentifier()

Returns:

field

setSubjectIdentifier

public void setSubjectIdentifier(java.lang.String subjectIdentifier1)

Parameters:

subjectIdentifier1 -

getActAsSubjectId

public java.lang.String getActAsSubjectId()

Returns:

field

setActAsSubjectId

public void setActAsSubjectId(java.lang.String actAsSubjectId1)

Parameters:

actAsSubjectId1 -

getActAsSubjectSourceId

public java.lang.String getActAsSubjectSourceId()

Returns:

field

setActAsSubjectSourceId

public void setActAsSubjectSourceId(java.lang.String actAsSubjectSource1)

Parameters:

actAsSubjectSource1 -

getActAsSubjectIdentifier

public java.lang.String getActAsSubjectIdentifier()

Returns:

field

setActAsSubjectIdentifier

public void setActAsSubjectIdentifier(java.lang.String actAsSubjectIdentifier1)

Parameters:

actAsSubjectIdentifier1 -

getMemberFilter

public java.lang.String getMemberFilter()

Returns:

field

setMemberFilter

public void setMemberFilter(java.lang.String fieldName1)

Parameters:

fieldName1 -

getIncludeGroupDetail

public java.lang.String getIncludeGroupDetail()

Returns:

field

setIncludeGroupDetail

public void setIncludeGroupDetail(java.lang.String includeGroupDetail1)

Parameters:

includeGroupDetail1 -

getIncludeSubjectDetail

public java.lang.String getIncludeSubjectDetail()

Returns:

field

setIncludeSubjectDetail

public void setIncludeSubjectDetail(java.lang.String includeSubjectDetail1)

Parameters:

includeSubjectDetail1 -

getSubjectAttributeNames

public java.lang.String getSubjectAttributeNames()

Returns:

field

setSubjectAttributeNames

public void setSubjectAttributeNames(java.lang.String subjectAttributeNames1)

Parameters:

subjectAttributeNames1 -

getParamName0

public java.lang.String getParamName0()

Returns:

field

setParamName0

public void setParamName0(java.lang.String _paramName0)

Parameters:

_paramName0 -

getParamValue0

public java.lang.String getParamValue0()

Returns:

field

setParamValue0

public void setParamValue0(java.lang.String _paramValue0)

Parameters:

_paramValue0 -

getParamName1

public java.lang.String getParamName1()

Returns:

field

setParamName1

public void setParamName1(java.lang.String _paramName1)

Parameters:

_paramName1 -

getParamValue1

public java.lang.String getParamValue1()

Returns:

field

setParamValue1

public void setParamValue1(java.lang.String _paramValue1)

Parameters:

_paramValue1 -

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

getPointInTimeFrom

public java.lang.String getPointInTimeFrom()

To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSS

Returns:

the pointInTimeFrom

setPointInTimeFrom

public void setPointInTimeFrom(java.lang.String pointInTimeFrom1)

To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeTo. This parameter specifies the start of the range of the point in time query. If this is specified but pointInTimeTo is not specified, then the point in time query range will be from the time specified to now. Format: yyyy/MM/dd HH:mm:ss.SSS

Parameters:

pointInTimeFrom1 - the pointInTimeFrom to set

getPointInTimeTo

public java.lang.String getPointInTimeTo()

To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS

Returns:

the pointInTimeTo

setPointInTimeTo

public void setPointInTimeTo(java.lang.String pointInTimeTo1)

To query members at a certain point in time or time range in the past, set this value and/or the value of pointInTimeFrom. This parameter specifies the end of the range of the point in time query. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range. If this is specified but pointInTimeFrom is not specified, then the point in time query range will be from the minimum point in time to the time specified. Format: yyyy/MM/dd HH:mm:ss.SSS

Parameters:

pointInTimeTo1 - the pointInTimeTo to set