edu.internet2.middleware.grouperClient.ws.beans

Class WsRestGetGroupsRequest

java.lang.Object

edu.internet2.middleware.grouperClient.ws.beans.WsRestGetGroupsRequest

All Implemented Interfaces:

WsRequestBean

public class WsRestGetGroupsRequest
extends Object
implements WsRequestBean

bean that will be the data from rest request for method

Constructor Summary

Constructors

Constructor and Description
WsRestGetGroupsRequest()

Method Summary

Modifier and Type	Method and Description
WsSubjectLookup	getActAsSubjectLookup()
String	getAscending() ascending or null for ascending, F for descending.
String	getClientVersion()
String	getEnabled() enabled is A for all, T or null for enabled only, F for disabled
String	getFieldName() field name (list) to search, blank for members list
String	getIncludeGroupDetail()
String	getIncludeSubjectDetail()
String	getMemberFilter()
String	getPageCursorFieldIncludesLastRetrieved()
String	getPageIsCursor()
String	getPageLastCursorField()
String	getPageLastCursorFieldType()
String	getPageNumber() pageNumber page number 1 indexed if paging
String	getPageSize() pageSize page size if paging
WsParam[]	getParams()
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.
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.
String	getScope() scope is a DB pattern that will have % appended to it, or null for all.
String	getSortString() sortString must be an hql query field, e.g.
String	getStemScope() stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
String[]	getSubjectAttributeNames()
WsSubjectLookup[]	getSubjectLookups()
WsStemLookup	getWsStemLookup() is the stem to check in, or null if all.
void	setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
void	setAscending(String ascending1) ascending or null for ascending, F for descending.
void	setClientVersion(String clientVersion1)
void	setEnabled(String enabled1) enabled is A for all, T or null for enabled only, F for disabled
void	setFieldName(String fieldName1) field name (list) to search, blank for members list
void	setIncludeGroupDetail(String includeGroupDetail1)
void	setIncludeSubjectDetail(String includeSubjectDetail1)
void	setMemberFilter(String fieldName1)
void	setPageCursorFieldIncludesLastRetrieved(String pageCursorFieldIncludesLastRetrieved)
void	setPageIsCursor(String pageIsCursor)
void	setPageLastCursorField(String pageLastCursorField)
void	setPageLastCursorFieldType(String pageLastCursorFieldType)
void	setPageNumber(String pageNumber1) pageNumber page number 1 indexed if paging
void	setPageSize(String pageSize1) pageSize page size if paging
void	setParams(WsParam[] params1)
void	setPointInTimeFrom(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(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(String scope1) scope is a DB pattern that will have % appended to it, or null for all.
void	setSortString(String sortString1) sortString must be an hql query field, e.g.
void	setStemScope(String stemScope1) stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
void	setSubjectAttributeNames(String[] subjectAttributeNames1)
void	setSubjectLookups(WsSubjectLookup[] subjectLookups1)
void	setWsStemLookup(WsStemLookup wsStemLookup1) is the stem to check in, or null if all.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsRestGetGroupsRequest

public WsRestGetGroupsRequest()

Method Detail

getFieldName

public String getFieldName()

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

Returns:

field name

setFieldName

public void setFieldName(String fieldName1)

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

Parameters:

fieldName1 -

getScope

public 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(String scope1)

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

Parameters:

scope1 -

getWsStemLookup

public WsStemLookup getWsStemLookup()

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

Returns:

stem lookup

setWsStemLookup

public void setWsStemLookup(WsStemLookup wsStemLookup1)

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

Parameters:

wsStemLookup1 -

getStemScope

public 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(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 String getEnabled()

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

Returns:

enabled string

setEnabled

public void setEnabled(String enabled1)

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

Parameters:

enabled1 -

getPageSize

public String getPageSize()

pageSize page size if paging

Returns:

page size

setPageSize

public void setPageSize(String pageSize1)

pageSize page size if paging

Parameters:

pageSize1 -

getPageNumber

public String getPageNumber()

pageNumber page number 1 indexed if paging

Returns:

page number

setPageNumber

public void setPageNumber(String pageNumber1)

pageNumber page number 1 indexed if paging

Parameters:

pageNumber1 -

getSortString

public 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(String sortString1)

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

Parameters:

sortString1 -

getAscending

public 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(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 String getClientVersion()

Returns:

the clientVersion

setClientVersion

public void setClientVersion(String clientVersion1)

Parameters:

clientVersion1 - the clientVersion to set

getSubjectLookups

public WsSubjectLookup[] getSubjectLookups()

Returns:

the subjectLookups

setSubjectLookups

public void setSubjectLookups(WsSubjectLookup[] subjectLookups1)

Parameters:

subjectLookups1 - the subjectLookups to set

getActAsSubjectLookup

public WsSubjectLookup getActAsSubjectLookup()

Returns:

the actAsSubjectLookup

setActAsSubjectLookup

public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)

Parameters:

actAsSubjectLookup1 - the actAsSubjectLookup to set

getMemberFilter

public String getMemberFilter()

Returns:

the fieldName

setMemberFilter

public void setMemberFilter(String fieldName1)

Parameters:

fieldName1 - the fieldName to set

getIncludeGroupDetail

public String getIncludeGroupDetail()

Returns:

the includeGroupDetail

setIncludeGroupDetail

public void setIncludeGroupDetail(String includeGroupDetail1)

Parameters:

includeGroupDetail1 - the includeGroupDetail to set

getIncludeSubjectDetail

public String getIncludeSubjectDetail()

Returns:

the includeSubjectDetail

setIncludeSubjectDetail

public void setIncludeSubjectDetail(String includeSubjectDetail1)

Parameters:

includeSubjectDetail1 - the includeSubjectDetail to set

getSubjectAttributeNames

public String[] getSubjectAttributeNames()

Returns:

the subjectAttributeNames

setSubjectAttributeNames

public void setSubjectAttributeNames(String[] subjectAttributeNames1)

Parameters:

subjectAttributeNames1 - the subjectAttributeNames to set

getParams

public WsParam[] getParams()

Returns:

the params

setParams

public void setParams(WsParam[] params1)

Parameters:

params1 - the params to set

getPointInTimeFrom

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

getPageIsCursor

public String getPageIsCursor()

Returns:

the pageIsCursor

setPageIsCursor

public void setPageIsCursor(String pageIsCursor)

Parameters:

pageIsCursor - the pageIsCursor to set

getPageLastCursorField

public String getPageLastCursorField()

Returns:

the pageLastCursorField

setPageLastCursorField

public void setPageLastCursorField(String pageLastCursorField)

Parameters:

pageLastCursorField - the pageLastCursorField to set

getPageLastCursorFieldType

public String getPageLastCursorFieldType()

Returns:

the pageLastCursorFieldType

setPageLastCursorFieldType

public void setPageLastCursorFieldType(String pageLastCursorFieldType)

Parameters:

pageLastCursorFieldType - the pageLastCursorFieldType to set

getPageCursorFieldIncludesLastRetrieved

public String getPageCursorFieldIncludesLastRetrieved()

Returns:

the pageCursorFieldIncludesLastRetrieved

setPageCursorFieldIncludesLastRetrieved

public void setPageCursorFieldIncludesLastRetrieved(String pageCursorFieldIncludesLastRetrieved)

Parameters:

pageCursorFieldIncludesLastRetrieved - the pageCursorFieldIncludesLastRetrieved to set