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

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

public class WsQueryFilter
extends Object

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


Constructor Summary
WsQueryFilter()
           
 
Method Summary
 String getGroupAttributeName()
          if querying, this is the attribute name, or null or search all attributes
 String getGroupAttributeValue()
          groupAttributeValue if searching by query, this is a term that will be matched to
 String getGroupName()
          groupName search by group name (must match exactly), cannot use other params with this
 String getGroupTypeName()
          if searching by type, this is the type to search for.
 String getGroupUuid()
          groupUuid search by group uuid (must match exactly), cannot use other
 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
 String getQueryFilterType()
          findGroupType is the WsQueryFilterType enum for which type of find is happening: e.g.
 String getQueryTerm()
          queryTerm if searching by query, this is a term that will be matched to name, extension, etc
 String getStemName()
          stemName will return groups only in this stem
 String getStemNameScope()
          stemNameScope if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree.
 void setGroupAttributeName(String attributeName1)
          if querying, this is the attribute name, or null or search all attributes
 void setGroupAttributeValue(String groupAttributeValue1)
          groupAttributeValue if searching by query, this is a term that will be matched to
 void setGroupName(String groupName1)
          groupName search by group name (must match exactly), cannot use other params with this
 void setGroupTypeName(String theType1)
          if searching by type, this is the type to search for.
 void setGroupUuid(String groupUuid1)
          groupUuid search by group uuid (must match exactly), cannot use other
 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(String findGroupType1)
          findGroupType is the WsQueryFilterType enum for which type of find is happening: e.g.
 void setQueryTerm(String queryTerm1)
          queryTerm if searching by query, this is a term that will be matched to name, extension, etc
 void setStemName(String stemName1)
          stemName will return groups only in this stem
 void setStemNameScope(String stemNameScope1)
          stemNameScope if searching by stem, ONE_LEVEL is for one level, ALL_IN_SUBTREE will return all in sub tree.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsQueryFilter

public WsQueryFilter()
Method Detail

getQueryFilterType

public String getQueryFilterType()
findGroupType is the WsQueryFilterType enum for which type of find is happening: e.g. FIND_BY_GROUP_UUID, FIND_BY_GROUP_NAME_EXACT, FIND_BY_STEM_NAME, FIND_BY_APPROXIMATE_ATTRIBUTE, FIND_BY_ATTRIBUTE, FIND_BY_GROUP_NAME_APPROXIMATE, FIND_BY_TYPE, AND, OR, MINUS;

Returns:
the findGroupType

setQueryFilterType

public void setQueryFilterType(String findGroupType1)
findGroupType is the WsQueryFilterType enum for which type of find is happening: e.g. FIND_BY_GROUP_UUID, FIND_BY_GROUP_NAME_EXACT, FIND_BY_STEM_NAME, FIND_BY_APPROXIMATE_ATTRIBUTE, FIND_BY_ATTRIBUTE, FIND_BY_GROUP_NAME_APPROXIMATE, FIND_BY_TYPE, AND, OR, MINUS;

Parameters:
findGroupType1 - the findGroupType to set

getGroupName

public String getGroupName()
groupName search by group name (must match exactly), cannot use other params with this

Returns:
the groupName

setGroupName

public void setGroupName(String groupName1)
groupName search by group name (must match exactly), cannot use other params with this

Parameters:
groupName1 - the groupName to set

getStemName

public String getStemName()
stemName will return groups only in this stem

Returns:
the stemName

setStemName

public void setStemName(String stemName1)
stemName will return groups only in this stem

Parameters:
stemName1 - the stemName to set

getStemNameScope

public String getStemNameScope()
stemNameScope 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 stemNameScope

setStemNameScope

public void setStemNameScope(String stemNameScope1)
stemNameScope 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 stemNameScope to set

getGroupUuid

public String getGroupUuid()
groupUuid search by group uuid (must match exactly), cannot use other

Returns:
the groupUuid

setGroupUuid

public void setGroupUuid(String groupUuid1)
groupUuid search by group uuid (must match exactly), cannot use other

Parameters:
groupUuid1 - the groupUuid to set

getQueryTerm

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

getGroupAttributeName

public String getGroupAttributeName()
if querying, this is the attribute name, or null or search all attributes

Returns:
the attributeName

setGroupAttributeName

public void setGroupAttributeName(String attributeName1)
if querying, this is the attribute name, or null or search all attributes

Parameters:
attributeName1 - the attributeName to set

getGroupTypeName

public String getGroupTypeName()
if searching by type, this is the type to search for. not yet implemented

Returns:
the theType

setGroupTypeName

public void setGroupTypeName(String theType1)
if searching by type, this is the type to search for. not yet implemented

Parameters:
theType1 - the theType to set

getQueryFilter0

public WsQueryFilter getQueryFilter0()
if 'and' or 'or' this is the first group, and if complement, this is the group to complement

Returns:
the queryFilter0

setQueryFilter0

public void setQueryFilter0(WsQueryFilter theQueryFilter0)
if 'and' or 'or' this is the first group, and if complement, this is the group to complement

Parameters:
theQueryFilter0 - the queryFilter0 to set

getQueryFilter1

public WsQueryFilter getQueryFilter1()
if 'and' or 'or', this is the second group

Returns:
the queryFilter1

setQueryFilter1

public void setQueryFilter1(WsQueryFilter theQueryFilter1)
if 'and' or 'or', this is the second group

Parameters:
theQueryFilter1 - the queryFilter1 to set

getGroupAttributeValue

public String getGroupAttributeValue()
groupAttributeValue if searching by query, this is a term that will be matched to

Returns:
the groupAttributeValue

setGroupAttributeValue

public void setGroupAttributeValue(String groupAttributeValue1)
groupAttributeValue if searching by query, this is a term that will be matched to

Parameters:
groupAttributeValue1 - the groupAttributeValue to set