public class WsQueryFilter
extends java.lang.Object
Constructor and Description |
---|
WsQueryFilter() |
Modifier and Type | Method and Description |
---|---|
void |
assignGrouperSession(GrouperSession grouperSession1)
grouper session
|
java.lang.String |
getAscending()
true or null for ascending, false for descending.
|
java.lang.String |
getGroupAttributeName()
if querying, this is the attribute name, or null or search
all attributes
|
java.lang.String |
getGroupAttributeValue()
groupAttributeValue if searching by query, this is a term that will be matched to
|
java.lang.String |
getGroupName()
groupName search by group name (must match exactly), cannot use other params with this
|
java.lang.String |
getGroupTypeName()
if searching by type, this is the type to search for.
|
java.lang.String |
getGroupUuid()
groupUuid search by group uuid (must match exactly), cannot use other
|
java.lang.String |
getPageNumber()
page number 1 indexed if paging
|
java.lang.String |
getPageSize()
page size if paging
|
WsQueryFilter |
getQueryFilter0()
if 'and' or 'or' this is the first group, and if complement,
this is the group to complement
|
WsQueryFilter |
getQueryFilter1()
if 'and' or 'or', this is the second group
|
java.lang.String |
getQueryFilterType()
findGroupType is the WsQueryFilterType enum for which type of find is happening: e.g.
|
java.lang.String |
getQueryTerm()
queryTerm if searching by query, this is a term that will be matched to
name, extension, etc
|
java.lang.String |
getSortString()
must be an hql query field, e.g.
|
java.lang.String |
getStemName()
stemName will return groups only in this stem
|
java.lang.String |
getStemNameScope()
stemNameScope
if searching by stem, ONE_LEVEL is for one level,
ALL_IN_SUBTREE will return all in sub tree.
|
java.lang.String |
getTypeOfGroups()
comma separated type of groups can be an enum of TypeOfGroup, e.g.
|
java.lang.Boolean |
retrieveAscending()
true or null for ascending, false for descending.
|
GrouperSession |
retrieveGrouperSession()
grouper session
|
GroupType |
retrieveGroupType()
if there is no group type name, return null
if there is a group type name, then find it, and return it.
|
java.lang.Integer |
retrievePageNumber()
page number 1 indexed if paging
|
java.lang.Integer |
retrievePageSize()
page size if paging
|
QueryFilter |
retrieveQueryFilter()
convert the query into a query filter
|
WsQueryFilterType |
retrieveQueryFilterType() |
Stem |
retrieveStem()
if there is no stem, return null.
|
StemScope |
retrieveStemScope(StemScope defaultScope)
convert the stem scope into a stem scope
|
java.util.Set<TypeOfGroup> |
retrieveTypeOfGroups() |
void |
setAscending(java.lang.String ascending1)
true or null for ascending, false for descending.
|
void |
setGroupAttributeName(java.lang.String attributeName1)
if querying, this is the attribute name, or null or search
all attributes
|
void |
setGroupAttributeValue(java.lang.String groupAttributeValue1)
groupAttributeValue if searching by query, this is a term that will be matched to
|
void |
setGroupName(java.lang.String groupName1)
groupName search by group name (must match exactly), cannot use other params with this
|
void |
setGroupTypeName(java.lang.String theType1)
if searching by type, this is the type to search for.
|
void |
setGroupUuid(java.lang.String groupUuid1)
groupUuid search by group uuid (must match exactly), cannot use other
|
void |
setPageNumber(java.lang.String pageNumber1)
page number 1 indexed if paging
|
void |
setPageSize(java.lang.String pageSize1)
page size if paging
|
void |
setQueryFilter0(WsQueryFilter theQueryFilter0)
if 'and' or 'or' this is the first group, and if complement,
this is the group to complement
|
void |
setQueryFilter1(WsQueryFilter theQueryFilter1)
if 'and' or 'or', this is the second group
|
void |
setQueryFilterType(java.lang.String findGroupType1)
findGroupType is the WsQueryFilterType enum for which type of find is happening:
e.g.
|
void |
setQueryTerm(java.lang.String queryTerm1)
queryTerm if searching by query, this is a term that will be matched to
name, extension, etc
|
void |
setSortString(java.lang.String sortString1)
must be an hql query field, e.g.
|
void |
setStemName(java.lang.String stemName1)
stemName will return groups only in this stem
|
void |
setStemNameScope(java.lang.String stemNameScope1)
stemNameScope
if searching by stem, ONE_LEVEL is for one level,
ALL_IN_SUBTREE will return all in sub tree.
|
void |
setTypeOfGroups(java.lang.String typeOfGroups1)
comma separated type of groups can be an enum of TypeOfGroup, e.g.
|
java.lang.String |
toString() |
void |
validate()
validate the tree of queries
|
void |
validateHasGroupAttributeName()
if there is no attribute name, there should be
|
void |
validateHasGroupAttributeValue()
if there is no groupAttributeValue, there should be
|
void |
validateHasGroupName()
if there is no group name, there should be
|
void |
validateHasGroupTypeName()
if there is no type, there should be
|
void |
validateHasGroupUuid()
if there is no group uuid, there should be
|
void |
validateHasQueryFilter0()
if there is no query filter 0, there should be
|
void |
validateHasQueryFilter1()
if there is no query filter 1, there should be
|
void |
validateHasStemName()
if there is no stem name, there should be
|
void |
validateHasStemNameScope()
if there is no group name, there should be
|
void |
validateNoGroupAttributeName()
if there is a attribute name, there shouldnt be
|
void |
validateNoGroupAttributeValue()
if there is a groupAttributeValue, there shouldnt be
|
void |
validateNoGroupName()
if there is a group name, there shouldnt be
|
void |
validateNoGroupTypeName()
if there is a type, there shouldnt be
|
void |
validateNoGroupUuid()
if there is a group uuid, there shouldnt be
|
void |
validateNoQueryFilter0()
if there is a query filter 0, there shouldnt be
|
void |
validateNoQueryFilter1()
if there is a query filter 1, there shouldnt be
|
void |
validateNoStemName()
if there is a stem name, there shouldnt be
|
void |
validateNoStemNameScope()
if there is a group name, there shouldnt be
|
void |
validateNoTypeOfGroups()
if there is a typeOfGroup name, there shouldnt be
|
void |
validateShouldHavePagingSorting(boolean canHavePagingSorting)
if there is no attribute name, there should be
|
public java.lang.String getTypeOfGroups()
public void setTypeOfGroups(java.lang.String typeOfGroups1)
typeOfGroups1
- public java.lang.Integer retrievePageSize()
public java.lang.Boolean retrieveAscending()
public java.lang.Integer retrievePageNumber()
public java.lang.String getPageSize()
public void setPageSize(java.lang.String pageSize1)
pageSize1
- the pageSize to setpublic java.lang.String getPageNumber()
public void setPageNumber(java.lang.String pageNumber1)
pageNumber1
- the pageNumber to setpublic java.lang.String getSortString()
public void setSortString(java.lang.String sortString1)
sortString1
- the sortString to setpublic java.lang.String getAscending()
public void setAscending(java.lang.String ascending1)
ascending1
- the ascending to setpublic void validateNoGroupName()
public void validateHasGroupName()
public void validateNoTypeOfGroups()
public void validateNoStemName()
public void validateHasStemName()
public void validateNoStemNameScope()
public void validateHasStemNameScope()
public void validateNoGroupUuid()
public void validateHasGroupUuid()
public void validateNoGroupAttributeValue()
public void validateHasGroupAttributeValue()
public void validateNoGroupAttributeName()
public void validateShouldHavePagingSorting(boolean canHavePagingSorting)
canHavePagingSorting
- if can have paging/sortingpublic void validateHasGroupAttributeName()
public void validateNoGroupTypeName()
public void validateHasGroupTypeName()
public void validateNoQueryFilter0()
public void validateHasQueryFilter0()
public void validateNoQueryFilter1()
public void validateHasQueryFilter1()
public java.lang.String getQueryFilterType()
public void setQueryFilterType(java.lang.String findGroupType1)
findGroupType1
- the findGroupType to setpublic java.lang.String getGroupName()
public void setGroupName(java.lang.String groupName1)
groupName1
- the groupName to setpublic java.lang.String getStemName()
public void setStemName(java.lang.String stemName1)
stemName1
- the stemName to setpublic java.lang.String getStemNameScope()
public StemScope retrieveStemScope(StemScope defaultScope)
defaultScope
- is the default scopepublic void setStemNameScope(java.lang.String stemNameScope1)
stemNameScope1
- the stemNameScope to setpublic java.lang.String getGroupUuid()
public void setGroupUuid(java.lang.String groupUuid1)
groupUuid1
- the groupUuid to setpublic java.lang.String getQueryTerm()
public void setQueryTerm(java.lang.String queryTerm1)
queryTerm1
- the queryTerm to setpublic java.lang.String getGroupAttributeName()
public void setGroupAttributeName(java.lang.String attributeName1)
attributeName1
- the attributeName to setpublic java.lang.String getGroupTypeName()
public void setGroupTypeName(java.lang.String theType1)
theType1
- the theType to setpublic WsQueryFilter getQueryFilter0()
public void setQueryFilter0(WsQueryFilter theQueryFilter0)
theQueryFilter0
- the queryFilter0 to setpublic WsQueryFilter getQueryFilter1()
public void setQueryFilter1(WsQueryFilter theQueryFilter1)
theQueryFilter1
- the queryFilter1 to setpublic QueryFilter retrieveQueryFilter()
public WsQueryFilterType retrieveQueryFilterType()
public java.util.Set<TypeOfGroup> retrieveTypeOfGroups()
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public void validate()
public Stem retrieveStem()
public GroupType retrieveGroupType()
public GrouperSession retrieveGrouperSession()
public void assignGrouperSession(GrouperSession grouperSession1)
grouperSession1
- the grouperSession to setpublic java.lang.String getGroupAttributeValue()
public void setGroupAttributeValue(java.lang.String groupAttributeValue1)
groupAttributeValue1
- the groupAttributeValue to set