Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.profiles.search
Class ProfileSearchQuery

java.lang.Object
  extended by com.jivesoftware.profiles.search.ProfileSearchQuery

public class ProfileSearchQuery
extends java.lang.Object

Contains the necessary information to perform a user search.


Constructor Summary
ProfileSearchQuery(java.lang.String query)
           
ProfileSearchQuery(java.lang.String keywords, java.util.List filters, boolean username, boolean name, boolean email, boolean profile, boolean admin)
           
ProfileSearchQuery(java.lang.String keywords, java.util.List filters, boolean username, boolean name, boolean email, boolean profile, boolean admin, java.util.Locale locale)
           
 
Method Summary
 java.util.List getFilters()
           
 java.lang.String getKeywords()
           
 java.util.Locale getLocale()
           
 boolean isAdmin()
          Return True if the user performing the search is a system administrator, false otherwise.
 boolean isEmail()
           
 boolean isName()
           
 boolean isProfile()
           
 boolean isUsername()
           
 void setAdmin(boolean admin)
          True if the user performing the search is a system administrator, false otherwise.
 void setEmail(boolean email)
           
 void setFilters(java.util.List filters)
           
 void setLocale(java.util.Locale locale)
           
 void setName(boolean name)
           
 void setProfile(boolean profile)
           
 void setQuery(java.lang.String keywords)
           
 void setUsername(boolean username)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProfileSearchQuery

public ProfileSearchQuery(java.lang.String query)

ProfileSearchQuery

public ProfileSearchQuery(java.lang.String keywords,
                          java.util.List filters,
                          boolean username,
                          boolean name,
                          boolean email,
                          boolean profile,
                          boolean admin)

ProfileSearchQuery

public ProfileSearchQuery(java.lang.String keywords,
                          java.util.List filters,
                          boolean username,
                          boolean name,
                          boolean email,
                          boolean profile,
                          boolean admin,
                          java.util.Locale locale)
Method Detail

getKeywords

public java.lang.String getKeywords()

setQuery

public void setQuery(java.lang.String keywords)

getFilters

public java.util.List getFilters()

setFilters

public void setFilters(java.util.List filters)

isUsername

public boolean isUsername()

setUsername

public void setUsername(boolean username)

isName

public boolean isName()

setName

public void setName(boolean name)

isEmail

public boolean isEmail()

setEmail

public void setEmail(boolean email)

isProfile

public boolean isProfile()

setProfile

public void setProfile(boolean profile)

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale)

isAdmin

public boolean isAdmin()
Return True if the user performing the search is a system administrator, false otherwise. Note: This field must be set to true to search hidden names and email addresses. This class does not validate that the user is in fact an admin, that responsibility is left to the caller of this class.

Returns:
true if the user performing the search is a system administrator, false otherwise.

setAdmin

public void setAdmin(boolean admin)
True if the user performing the search is a system administrator, false otherwise. Note: This field must be set to true to search hidden names and email addresses. This class does not validate that the user is in fact an admin, that responsibility is left to the caller of this class.

Parameters:
admin - true if the user performing the search is a system administrator, false otherwise.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.