public class WsStemQueryFilter
extends java.lang.Object
Constructor and Description |
---|
WsStemQueryFilter() |
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 |
getPageNumber()
page number 1 indexed if paging
|
java.lang.String |
getPageSize()
page size if paging
|
java.lang.String |
getParentStemName()
parentStemName will return stems only in this stem
|
java.lang.String |
getParentStemNameScope()
parentStemNameScope
if searching by stem, ONE_LEVEL is for one level,
ALL_IN_SUBTREE will return all in sub tree.
|
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 |
getStemAttributeName()
if querying, this is the attribute name, or null or search
all attributes
|
java.lang.String |
getStemAttributeValue()
stemAttributeValue if searching by query, this is a term that will be matched to
|
java.lang.String |
getStemName()
stemName search by stem name (must match exactly), cannot use other params with this
|
WsStemQueryFilter |
getStemQueryFilter0()
if 'and' or 'or' this is the first stem, and if complement,
this is the stem to complement
|
WsStemQueryFilter |
getStemQueryFilter1()
if 'and' or 'or', this is the second stem
|
java.lang.String |
getStemQueryFilterType()
findStemType is the WsFindStemType enum for which type of find is happening: e.g.
|
java.lang.String |
getStemUuid()
stemUuid search by stem uuid (must match exactly), cannot use other
|
java.lang.Boolean |
retrieveAscending()
true or null for ascending, false for descending.
|
GrouperSession |
retrieveGrouperSession()
grouper session
|
java.lang.Integer |
retrievePageNumber()
page number 1 indexed if paging
|
java.lang.Integer |
retrievePageSize()
page size if paging
|
Stem |
retrieveParentStem()
if there is no stem, return null.
|
QueryFilter |
retrieveQueryFilter()
convert the query into a query filter
|
WsStemQueryFilterType |
retrieveStemQueryFilterType() |
StemScope |
retrieveStemScope(StemScope defaultScope)
convert the stem scope into a stem scope
|
void |
setAscending(java.lang.String ascending1)
true or null for ascending, false for descending.
|
void |
setPageNumber(java.lang.String pageNumber1)
page number 1 indexed if paging
|
void |
setPageSize(java.lang.String pageSize1)
page size if paging
|
void |
setParentStemName(java.lang.String stemName1)
parentStemName will return stems only in this stem
|
void |
setParentStemNameScope(java.lang.String stemNameScope1)
parentStemNameScope
if searching by stem, ONE_LEVEL is for one level,
ALL_IN_SUBTREE will return all in sub tree.
|
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 |
setStemAttributeName(java.lang.String attributeName1)
if querying, this is the attribute name, or null or search
all attributes
|
void |
setStemAttributeValue(java.lang.String stemAttributeValue1)
stemAttributeValue if searching by query, this is a term that will be matched to
|
void |
setStemName(java.lang.String stemName1)
stemName search by stem name (must match exactly), cannot use other params with this
|
void |
setStemQueryFilter0(WsStemQueryFilter theQueryFilter0)
if 'and' or 'or' this is the first stem, and if complement,
this is the stem to complement
|
void |
setStemQueryFilter1(WsStemQueryFilter theQueryFilter1)
if 'and' or 'or', this is the second stem
|
void |
setStemQueryFilterType(java.lang.String findStemType1)
findStemType is the WsFindStemType enum for which type of find is happening:
e.g.
|
void |
setStemUuid(java.lang.String stemUuid1)
stemUuid search by stem uuid (must match exactly), cannot use other
|
java.lang.String |
toString() |
void |
validate()
validate the tree of queries
|
void |
validateHasParentStemName()
if there is no parent stem name, there should be
|
void |
validateHasParentStemNameScope()
if there is no parent stem name, there should be
|
void |
validateHasStemAttributeName()
if there is no attribute name, there should be
|
void |
validateHasStemAttributeValue()
if there is no stemAttributeValue, there should be
|
void |
validateHasStemName()
if there is no stem name, there should be
|
void |
validateHasStemQueryFilter0()
if there is no stem query filter 0, there should be
|
void |
validateHasStemQueryFilter1()
if there is no stem query filter 1, there should be
|
void |
validateHasStemUuid()
if there is no stem uuid, there should be
|
void |
validateNoParentStemName()
if there is a parent stem name, there shouldnt be
|
void |
validateNoParentStemNameScope()
if there is a parent stem name, there shouldnt be
|
void |
validateNoStemAttributeName()
if there is a attribute name, there shouldnt be
|
void |
validateNoStemAttributeValue()
if there is a stemAttributeValue, there shouldnt be
|
void |
validateNoStemName()
if there is a stem name, there shouldnt be
|
void |
validateNoStemQueryFilter0()
if there is a stem query filter 0, there shouldnt be
|
void |
validateNoStemQueryFilter1()
if there is a stem query filter 1, there shouldnt be
|
void |
validateNoStemUuid()
if there is a stem uuid, there shouldnt be
|
public void validateNoStemName()
public void validateHasStemName()
public void validateNoParentStemName()
public void validateHasParentStemName()
public void validateNoParentStemNameScope()
public void validateHasParentStemNameScope()
public void validateNoStemUuid()
public void validateHasStemUuid()
public void validateNoStemAttributeValue()
public void validateHasStemAttributeValue()
public void validateNoStemAttributeName()
public void validateHasStemAttributeName()
public void validateNoStemQueryFilter0()
public void validateHasStemQueryFilter0()
public void validateNoStemQueryFilter1()
public void validateHasStemQueryFilter1()
public java.lang.String getStemQueryFilterType()
public void setStemQueryFilterType(java.lang.String findStemType1)
findStemType1
- the findStemType to setpublic java.lang.String getStemName()
public void setStemName(java.lang.String stemName1)
stemName1
- the stemName to setpublic java.lang.String getParentStemName()
public void setParentStemName(java.lang.String stemName1)
stemName1
- the parentStemName to setpublic java.lang.String getParentStemNameScope()
public StemScope retrieveStemScope(StemScope defaultScope)
defaultScope
- is the default scopepublic void setParentStemNameScope(java.lang.String stemNameScope1)
stemNameScope1
- the parentStemNameScope to setpublic java.lang.String getStemUuid()
public void setStemUuid(java.lang.String stemUuid1)
stemUuid1
- the stemUuid to setpublic java.lang.String getQueryTerm()
public void setQueryTerm(java.lang.String queryTerm1)
queryTerm1
- the queryTerm to setpublic java.lang.String getStemAttributeName()
public void setStemAttributeName(java.lang.String attributeName1)
attributeName1
- the attributeName to setpublic WsStemQueryFilter getStemQueryFilter0()
public void setStemQueryFilter0(WsStemQueryFilter theQueryFilter0)
theQueryFilter0
- the stemQueryFilter0 to setpublic WsStemQueryFilter getStemQueryFilter1()
public void setStemQueryFilter1(WsStemQueryFilter theQueryFilter1)
theQueryFilter1
- the stemQueryFilter1 to setpublic QueryFilter retrieveQueryFilter()
public WsStemQueryFilterType retrieveStemQueryFilterType()
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public void validate()
public Stem retrieveParentStem()
public GrouperSession retrieveGrouperSession()
public void assignGrouperSession(GrouperSession grouperSession1)
grouperSession1
- the grouperSession to setpublic java.lang.String getStemAttributeValue()
public void setStemAttributeValue(java.lang.String stemAttributeValue1)
stemAttributeValue1
- the stemAttributeValue to setpublic java.lang.String getAscending()
public java.lang.String getPageNumber()
public java.lang.String getPageSize()
public java.lang.String getSortString()
public void setAscending(java.lang.String ascending1)
ascending1
- the ascending to setpublic void setPageNumber(java.lang.String pageNumber1)
pageNumber1
- the pageNumber to setpublic void setPageSize(java.lang.String pageSize1)
pageSize1
- the pageSize to setpublic void setSortString(java.lang.String sortString1)
sortString1
- the sortString to setpublic java.lang.Boolean retrieveAscending()
public java.lang.Integer retrievePageNumber()
public java.lang.Integer retrievePageSize()