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

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

public class WsRestGetGroupsLiteRequest
extends Object
implements WsRequestBean

lite bean that will be the data from rest request

See Also:
for lite method

Constructor Summary
WsRestGetGroupsLiteRequest()
           
 
Method Summary
 String getActAsSubjectId()
           
 String getActAsSubjectIdentifier()
           
 String getActAsSubjectSourceId()
           
 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 getPageNumber()
          pageNumber page number 1 indexed if paging
 String getPageSize()
          pageSize page size if paging
 String getParamName0()
           
 String getParamName1()
           
 String getParamValue0()
           
 String getParamValue1()
           
 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 getStemName()
          is the stem to check in, or null if all.
 String getStemScope()
          stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
 String getStemUuid()
          is the stem to check in, or null if all.
 String getSubjectAttributeNames()
           
 String getSubjectId()
           
 String getSubjectIdentifier()
           
 String getSubjectSourceId()
           
 GrouperRestHttpMethod retrieveRestHttpMethod()
          see which http method this is supposed to be associated with, and override whatever was passed in
 void setActAsSubjectId(String actAsSubjectId1)
           
 void setActAsSubjectIdentifier(String actAsSubjectIdentifier1)
           
 void setActAsSubjectSourceId(String actAsSubjectSource1)
           
 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 setPageNumber(String pageNumber1)
          pageNumber page number 1 indexed if paging
 void setPageSize(String pageSize1)
          pageSize page size if paging
 void setParamName0(String _paramName0)
           
 void setParamName1(String _paramName1)
           
 void setParamValue0(String _paramValue0)
           
 void setParamValue1(String _paramValue1)
           
 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 setStemName(String stemName1)
          is the stem to check in, or null if all.
 void setStemScope(String stemScope1)
          stemScope is ONE_LEVEL if in this stem, or ALL_IN_SUBTREE for any stem underneath.
 void setStemUuid(String stemUuid1)
          is the stem to check in, or null if all.
 void setSubjectAttributeNames(String subjectAttributeNames1)
           
 void setSubjectId(String subjectId1)
           
 void setSubjectIdentifier(String subjectIdentifier1)
           
 void setSubjectSourceId(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 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 -

getStemUuid

public 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(String stemUuid1)
is the stem to check in, or null if all. If has stem, must have stemScope

Parameters:
stemUuid1 -

getStemName

public 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(String stemName1)
is the stem to check in, or null if all. If has stem, must have stemScope

Parameters:
stemName1 -

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:
field

setClientVersion

public void setClientVersion(String clientVersion1)
Parameters:
clientVersion1 -

getSubjectId

public String getSubjectId()
Returns:
field

setSubjectId

public void setSubjectId(String subjectId1)
Parameters:
subjectId1 -

getSubjectSourceId

public String getSubjectSourceId()
Returns:
field

setSubjectSourceId

public void setSubjectSourceId(String subjectSource1)
Parameters:
subjectSource1 -

getSubjectIdentifier

public String getSubjectIdentifier()
Returns:
field

setSubjectIdentifier

public void setSubjectIdentifier(String subjectIdentifier1)
Parameters:
subjectIdentifier1 -

getActAsSubjectId

public String getActAsSubjectId()
Returns:
field

setActAsSubjectId

public void setActAsSubjectId(String actAsSubjectId1)
Parameters:
actAsSubjectId1 -

getActAsSubjectSourceId

public String getActAsSubjectSourceId()
Returns:
field

setActAsSubjectSourceId

public void setActAsSubjectSourceId(String actAsSubjectSource1)
Parameters:
actAsSubjectSource1 -

getActAsSubjectIdentifier

public String getActAsSubjectIdentifier()
Returns:
field

setActAsSubjectIdentifier

public void setActAsSubjectIdentifier(String actAsSubjectIdentifier1)
Parameters:
actAsSubjectIdentifier1 -

getMemberFilter

public String getMemberFilter()
Returns:
field

setMemberFilter

public void setMemberFilter(String fieldName1)
Parameters:
fieldName1 -

getIncludeGroupDetail

public String getIncludeGroupDetail()
Returns:
field

setIncludeGroupDetail

public void setIncludeGroupDetail(String includeGroupDetail1)
Parameters:
includeGroupDetail1 -

getIncludeSubjectDetail

public String getIncludeSubjectDetail()
Returns:
field

setIncludeSubjectDetail

public void setIncludeSubjectDetail(String includeSubjectDetail1)
Parameters:
includeSubjectDetail1 -

getSubjectAttributeNames

public String getSubjectAttributeNames()
Returns:
field

setSubjectAttributeNames

public void setSubjectAttributeNames(String subjectAttributeNames1)
Parameters:
subjectAttributeNames1 -

getParamName0

public String getParamName0()
Returns:
field

setParamName0

public void setParamName0(String _paramName0)
Parameters:
_paramName0 -

getParamValue0

public String getParamValue0()
Returns:
field

setParamValue0

public void setParamValue0(String _paramValue0)
Parameters:
_paramValue0 -

getParamName1

public String getParamName1()
Returns:
field

setParamName1

public void setParamName1(String _paramName1)
Parameters:
_paramName1 -

getParamValue1

public String getParamValue1()
Returns:
field

setParamValue1

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