edu.internet2.middleware.grouper.ws.coresoap
Class WsStemQueryFilter

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.coresoap.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
 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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WsStemQueryFilter

public WsStemQueryFilter()
Method Detail

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

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, 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

retrieveStemScope

public StemScope retrieveStemScope(StemScope defaultScope)
convert the stem scope into a stem scope

Parameters:
defaultScope - is the default scope
Returns:
the stem scope, or the default

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

retrieveQueryFilter

public QueryFilter retrieveQueryFilter()
convert the query into a query filter

Returns:
the query filter

retrieveStemQueryFilterType

public WsStemQueryFilterType retrieveStemQueryFilterType()
Returns:

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

validate

public void validate()
validate the tree of queries


retrieveParentStem

public Stem 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

public GrouperSession retrieveGrouperSession()
grouper session

Returns:
the grouperSession

assignGrouperSession

public void assignGrouperSession(GrouperSession grouperSession1)
grouper session

Parameters:
grouperSession1 - the grouperSession 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

retrieveAscending

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

public java.lang.Integer retrievePageNumber()
page number 1 indexed if paging

Returns:
page number 1 indexed if paging

retrievePageSize

public java.lang.Integer retrievePageSize()
page size if paging

Returns:
page size if paging