com.webmethods.sc.directory
Class DirectorySearchQuery

java.lang.Object
  extended by com.webmethods.sc.directory.DirectorySearchQuery

public class DirectorySearchQuery
extends Object

Class that describes directory service search query


Nested Class Summary
static class DirectorySearchQuery.RefineQueryField
          Describes refine field query for directory service
 
Constructor Summary
DirectorySearchQuery(String keywordQuery, int maxResults, DirectorySearchQuery.RefineQueryField[] refineQueryFields)
          Default constructor DirectorySearchQuery
 
Method Summary
 String getKeywordQuery()
          Returns keyword query for this search.
 int getMaxResults()
          Returns max number of results to return.
 DirectorySearchQuery.RefineQueryField[] getRefineQueryFields()
          Returns list of search refine fields
 void setKeywordQuery(String keywordQuery)
          Sets keyword query for this search.
 void setMaxResults(int maxResults)
          Sets max number of results to return.
 void setRefineQueryFields(DirectorySearchQuery.RefineQueryField[] refineQueryFields)
          Sets list of search refine fields
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DirectorySearchQuery

public DirectorySearchQuery(String keywordQuery,
                            int maxResults,
                            DirectorySearchQuery.RefineQueryField[] refineQueryFields)
Default constructor DirectorySearchQuery

Parameters:
keywordQuery - keyword search value. Passing on null or "" empty string will match to all principals to be searched
maxResults - maximum number of results to be returned by this query. Setting -1 will return all principals found
refineQueryFields - optional array of refined search fields
Method Detail

getKeywordQuery

public String getKeywordQuery()
Returns keyword query for this search. Empty string or null will match all principals


setKeywordQuery

public void setKeywordQuery(String keywordQuery)
Sets keyword query for this search. Empty string or null will match all principals


getMaxResults

public int getMaxResults()
Returns max number of results to return. -1 means all


setMaxResults

public void setMaxResults(int maxResults)
Sets max number of results to return. -1 means all


getRefineQueryFields

public DirectorySearchQuery.RefineQueryField[] getRefineQueryFields()
Returns list of search refine fields


setRefineQueryFields

public void setRefineQueryFields(DirectorySearchQuery.RefineQueryField[] refineQueryFields)
Sets list of search refine fields