Class WsStemQueryFilter
java.lang.Object
edu.internet2.middleware.grouper.ws.coresoap.WsStemQueryFilter
this represents a query which can be and'ed or or'ed
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
assignGrouperSession
(GrouperSession grouperSession1) grouper sessiontrue or null for ascending, false for descending.page number 1 indexed if pagingpage size if pagingparentStemName will return stems only in this stemparentStemNameScope if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree.queryTerm if searching by query, this is a term that will be matched to name, extension, etcmust be an hql query field, e.g.if querying, this is the attribute name, or null or search all attributesstemAttributeValue if searching by query, this is a term that will be matched tostemName search by stem name (must match exactly), cannot use other params with thisif 'and' or 'or' this is the first stem, and if complement, this is the stem to complementif 'and' or 'or', this is the second stemfindStemType is the WsFindStemType enum for which type of find is happening: e.g.stemUuid search by stem uuid (must match exactly), cannot use othertrue or null for ascending, false for descending.grouper sessionpage number 1 indexed if pagingpage size if pagingif there is no stem, return null.convert the query into a query filterretrieveStemScope
(StemScope defaultScope) convert the stem scope into a stem scopevoid
setAscending
(String ascending1) true or null for ascending, false for descending.void
setPageNumber
(String pageNumber1) page number 1 indexed if pagingvoid
setPageSize
(String pageSize1) page size if pagingvoid
setParentStemName
(String stemName1) parentStemName will return stems only in this stemvoid
setParentStemNameScope
(String stemNameScope1) parentStemNameScope if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree.void
setQueryTerm
(String queryTerm1) queryTerm if searching by query, this is a term that will be matched to name, extension, etcvoid
setSortString
(String sortString1) must be an hql query field, e.g.void
setStemAttributeName
(String attributeName1) if querying, this is the attribute name, or null or search all attributesvoid
setStemAttributeValue
(String stemAttributeValue1) stemAttributeValue if searching by query, this is a term that will be matched tovoid
setStemName
(String stemName1) stemName search by stem name (must match exactly), cannot use other params with thisvoid
setStemQueryFilter0
(WsStemQueryFilter theQueryFilter0) if 'and' or 'or' this is the first stem, and if complement, this is the stem to complementvoid
setStemQueryFilter1
(WsStemQueryFilter theQueryFilter1) if 'and' or 'or', this is the second stemvoid
setStemQueryFilterType
(String findStemType1) findStemType is the WsFindStemType enum for which type of find is happening: e.g.void
setStemUuid
(String stemUuid1) stemUuid search by stem uuid (must match exactly), cannot use othertoString()
void
validate()
validate the tree of queriesvoid
if there is no parent stem name, there should bevoid
if there is no parent stem name, there should bevoid
if there is no attribute name, there should bevoid
if there is no stemAttributeValue, there should bevoid
if there is no stem name, there should bevoid
if there is no stem query filter 0, there should bevoid
if there is no stem query filter 1, there should bevoid
if there is no stem uuid, there should bevoid
if there is a parent stem name, there shouldnt bevoid
if there is a parent stem name, there shouldnt bevoid
if there is a attribute name, there shouldnt bevoid
if there is a stemAttributeValue, there shouldnt bevoid
if there is a stem name, there shouldnt bevoid
if there is a stem query filter 0, there shouldnt bevoid
if there is a stem query filter 1, there shouldnt bevoid
if there is a stem uuid, there shouldnt be
-
Constructor Details
-
WsStemQueryFilter
public WsStemQueryFilter()
-
-
Method Details
-
validateNoStemName
public void validateNoStemName()if there is a stem name, there shouldnt be -
validateHasStemName
public void validateHasStemName()if there is no stem name, there should be -
validateNoParentStemName
public void validateNoParentStemName()if there is a parent stem name, there shouldnt be -
validateHasParentStemName
public void validateHasParentStemName()if there is no parent stem name, there should be -
validateNoParentStemNameScope
public void validateNoParentStemNameScope()if there is a parent stem name, there shouldnt be -
validateHasParentStemNameScope
public void validateHasParentStemNameScope()if there is no parent stem name, there should be -
validateNoStemUuid
public void validateNoStemUuid()if there is a stem uuid, there shouldnt be -
validateHasStemUuid
public void validateHasStemUuid()if there is no stem uuid, there should be -
validateNoStemAttributeValue
public void validateNoStemAttributeValue()if there is a stemAttributeValue, there shouldnt be -
validateHasStemAttributeValue
public void validateHasStemAttributeValue()if there is no stemAttributeValue, there should be -
validateNoStemAttributeName
public void validateNoStemAttributeName()if there is a attribute name, there shouldnt be -
validateHasStemAttributeName
public void validateHasStemAttributeName()if there is no attribute name, there should be -
validateNoStemQueryFilter0
public void validateNoStemQueryFilter0()if there is a stem query filter 0, there shouldnt be -
validateHasStemQueryFilter0
public void validateHasStemQueryFilter0()if there is no stem query filter 0, there should be -
validateNoStemQueryFilter1
public void validateNoStemQueryFilter1()if there is a stem query filter 1, there shouldnt be -
validateHasStemQueryFilter1
public void validateHasStemQueryFilter1()if there is no stem query filter 1, there should be -
getStemQueryFilterType
findStemType is the WsFindStemType enum for which type of find is happening: e.g. FIND_BY_STEM_UUID, FIND_BY_STEM_NAME, FIND_BY_STEM_NAME, FIND_BY_APPROXIMATE_ATTRIBUTE, FIND_BY_ATTRIBUTE, FIND_BY_TYPE, AND, OR, MINUS;- Returns:
- the findStemType
-
setStemQueryFilterType
findStemType is the WsFindStemType enum for which type of find is happening: e.g. FIND_BY_STEM_UUID, FIND_BY_STEM_NAME, FIND_BY_STEM_NAME, FIND_BY_APPROXIMATE_ATTRIBUTE, FIND_BY_ATTRIBUTE, FIND_BY_TYPE, AND, OR, MINUS;- Parameters:
findStemType1
- the findStemType to set
-
getStemName
stemName search by stem name (must match exactly), cannot use other params with this- Returns:
- the stemName
-
setStemName
stemName search by stem name (must match exactly), cannot use other params with this- Parameters:
stemName1
- the stemName to set
-
getParentStemName
parentStemName will return stems only in this stem- Returns:
- the parentStemName
-
setParentStemName
parentStemName will return stems only in this stem- Parameters:
stemName1
- the parentStemName to set
-
getParentStemNameScope
parentStemNameScope if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree. Default is ALL_IN_SUBTREE- Returns:
- the parentStemNameScope
-
retrieveStemScope
convert the stem scope into a stem scope- Parameters:
defaultScope
- is the default scope- Returns:
- the stem scope, or the default
-
setParentStemNameScope
parentStemNameScope if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree. Default is ALL_IN_SUBTREE- Parameters:
stemNameScope1
- the parentStemNameScope to set
-
getStemUuid
stemUuid search by stem uuid (must match exactly), cannot use other- Returns:
- the stemUuid
-
setStemUuid
stemUuid search by stem uuid (must match exactly), cannot use other- Parameters:
stemUuid1
- the stemUuid to set
-
getQueryTerm
queryTerm if searching by query, this is a term that will be matched to name, extension, etc- Returns:
- the queryTerm
-
setQueryTerm
queryTerm if searching by query, this is a term that will be matched to name, extension, etc- Parameters:
queryTerm1
- the queryTerm to set
-
getStemAttributeName
if querying, this is the attribute name, or null or search all attributes- Returns:
- the attributeName
-
setStemAttributeName
if querying, this is the attribute name, or null or search all attributes- Parameters:
attributeName1
- the attributeName to set
-
getStemQueryFilter0
if 'and' or 'or' this is the first stem, and if complement, this is the stem to complement- Returns:
- the stemQueryFilter0
-
setStemQueryFilter0
if 'and' or 'or' this is the first stem, and if complement, this is the stem to complement- Parameters:
theQueryFilter0
- the stemQueryFilter0 to set
-
getStemQueryFilter1
if 'and' or 'or', this is the second stem- Returns:
- the stemQueryFilter1
-
setStemQueryFilter1
if 'and' or 'or', this is the second stem- Parameters:
theQueryFilter1
- the stemQueryFilter1 to set
-
retrieveQueryFilter
convert the query into a query filter- Returns:
- the query filter
-
retrieveStemQueryFilterType
- Returns:
-
toString
-
validate
public void validate()validate the tree of queries -
retrieveParentStem
if there is no stem, return null. if there is a stem, then find it, and return it. If not found, then throw WsInvalidQueryException- Returns:
- the stem or null
-
retrieveGrouperSession
grouper session- Returns:
- the grouperSession
-
assignGrouperSession
grouper session- Parameters:
grouperSession1
- the grouperSession to set
-
getStemAttributeValue
stemAttributeValue if searching by query, this is a term that will be matched to- Returns:
- the stemAttributeValue
-
setStemAttributeValue
stemAttributeValue if searching by query, this is a term that will be matched to- Parameters:
stemAttributeValue1
- the stemAttributeValue to set
-
getAscending
true or null for ascending, false for descending. If you pass true or false, must pass a sort string- Returns:
- the ascending
-
getPageNumber
page number 1 indexed if paging- Returns:
- the pageNumber
-
getPageSize
page size if paging- Returns:
- the pageSize
-
getSortString
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Returns:
- the sortString
-
setAscending
true or null for ascending, false for descending. If you pass true or false, must pass a sort string- Parameters:
ascending1
- the ascending to set
-
setPageNumber
page number 1 indexed if paging- Parameters:
pageNumber1
- the pageNumber to set
-
setPageSize
page size if paging- Parameters:
pageSize1
- the pageSize to set
-
setSortString
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension- Parameters:
sortString1
- the sortString to set
-
retrieveAscending
true or null for ascending, false for descending. If you pass true or false, must pass a sort string- Returns:
- true or null for ascending, false for descending. If you pass true or false, must pass a sort string
-
retrievePageNumber
page number 1 indexed if paging- Returns:
- page number 1 indexed if paging
-
retrievePageSize
page size if paging- Returns:
- page size if paging
-