edu.internet2.middleware.grouperClient.ws.beans
Class WsStemQueryFilter

java.lang.Object
  extended by edu.internet2.middleware.grouperClient.ws.beans.WsStemQueryFilter

public class WsStemQueryFilter
extends java.lang.Object

this represents a query which can be and'ed or or'ed


Constructor Summary
WsStemQueryFilter()
           
 
Method Summary
 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
 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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsStemQueryFilter

public WsStemQueryFilter()
Method Detail

getStemQueryFilterType

public java.lang.String 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

public void setStemQueryFilterType(java.lang.String findStemType1)
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_APPROXIMATE, FIND_BY_APPROXIMATE_ATTRIBUTE, FIND_BY_ATTRIBUTE, FIND_BY_TYPE, AND, OR, MINUS;

Parameters:
findStemType1 - the findStemType to set

getStemName

public java.lang.String getStemName()
stemName search by stem name (must match exactly), cannot use other params with this

Returns:
the stemName

setStemName

public void setStemName(java.lang.String stemName1)
stemName search by stem name (must match exactly), cannot use other params with this

Parameters:
stemName1 - the stemName to set

getParentStemName

public java.lang.String getParentStemName()
parentStemName will return stems only in this stem

Returns:
the parentStemName

setParentStemName

public void setParentStemName(java.lang.String stemName1)
parentStemName will return stems only in this stem

Parameters:
stemName1 - the parentStemName to set

getParentStemNameScope

public java.lang.String 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

setParentStemNameScope

public 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. Default is ALL_IN_SUBTREE

Parameters:
stemNameScope1 - the parentStemNameScope to set

getStemUuid

public java.lang.String getStemUuid()
stemUuid search by stem uuid (must match exactly), cannot use other

Returns:
the stemUuid

setStemUuid

public void setStemUuid(java.lang.String stemUuid1)
stemUuid search by stem uuid (must match exactly), cannot use other

Parameters:
stemUuid1 - the stemUuid to set

getQueryTerm

public java.lang.String getQueryTerm()
queryTerm if searching by query, this is a term that will be matched to name, extension, etc

Returns:
the queryTerm

setQueryTerm

public void setQueryTerm(java.lang.String queryTerm1)
queryTerm if searching by query, this is a term that will be matched to name, extension, etc

Parameters:
queryTerm1 - the queryTerm to set

getStemAttributeName

public java.lang.String getStemAttributeName()
if querying, this is the attribute name, or null or search all attributes

Returns:
the attributeName

setStemAttributeName

public void setStemAttributeName(java.lang.String attributeName1)
if querying, this is the attribute name, or null or search all attributes

Parameters:
attributeName1 - the attributeName to set

getStemQueryFilter0

public WsStemQueryFilter getStemQueryFilter0()
if 'and' or 'or' this is the first stem, and if complement, this is the stem to complement

Returns:
the stemQueryFilter0

setStemQueryFilter0

public void setStemQueryFilter0(WsStemQueryFilter theQueryFilter0)
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

public WsStemQueryFilter getStemQueryFilter1()
if 'and' or 'or', this is the second stem

Returns:
the stemQueryFilter1

setStemQueryFilter1

public void setStemQueryFilter1(WsStemQueryFilter theQueryFilter1)
if 'and' or 'or', this is the second stem

Parameters:
theQueryFilter1 - the stemQueryFilter1 to set

getStemAttributeValue

public java.lang.String getStemAttributeValue()
stemAttributeValue if searching by query, this is a term that will be matched to

Returns:
the stemAttributeValue

setStemAttributeValue

public void setStemAttributeValue(java.lang.String stemAttributeValue1)
stemAttributeValue if searching by query, this is a term that will be matched to

Parameters:
stemAttributeValue1 - the stemAttributeValue to set

getAscending

public java.lang.String getAscending()
true or null for ascending, false for descending. If you pass true or false, must pass a sort string

Returns:
the ascending

getPageNumber

public java.lang.String getPageNumber()
page number 1 indexed if paging

Returns:
the pageNumber

getPageSize

public java.lang.String getPageSize()
page size if paging

Returns:
the pageSize

getSortString

public java.lang.String getSortString()
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension

Returns:
the sortString

setAscending

public void setAscending(java.lang.String ascending1)
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

public void setPageNumber(java.lang.String pageNumber1)
page number 1 indexed if paging

Parameters:
pageNumber1 - the pageNumber to set

setPageSize

public void setPageSize(java.lang.String pageSize1)
page size if paging

Parameters:
pageSize1 - the pageSize to set

setSortString

public void setSortString(java.lang.String sortString1)
must be an hql query field, e.g. can sort on name, displayName, extension, displayExtension

Parameters:
sortString1 - the sortString to set