Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> RuntimeCollective >> webapps >> [ form overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.RuntimeCollective.webapps.form.SearchUserForm JAVADOC | Sourc code of com.RuntimeCollective.webapps.form.SearchUserForm SOURCE | Download com.RuntimeCollective.webapps.form.SearchUserForm DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.RuntimeCollective.webapps.form
Class SearchUserForm  view SearchUserForm download SearchUserForm.java

java.lang.Object
  extended byorg.apache.struts.action.ActionForm
      extended bycom.RuntimeCollective.webapps.form.SearchUserForm
All Implemented Interfaces:
java.io.Serializable
public class SearchUserForm
extends org.apache.struts.action.ActionForm

A form for searching for users that match a certain set of criteria. This bean includes both the criteria for searching, and the results. The results can be populated using User.searchUser.

Version:
$Id: SearchUserForm.java,v 1.18 2003/09/30 15:13:14 joe Exp $, 13/8/2001

Field Summary
private  boolean acceptsEmptyForm
          AcceptsEmptyForm: if true we let pass empty forms (thus returning all users).
private  java.lang.String city
          City of user.
private  java.lang.String country
          Country code of residence of user.
private  java.lang.String email
          Part of the Email of user -- ie user will match if their email address contains this string.
private  java.lang.String first
          First name of user.
private  int groupId
          The id of a group the user belongs to.
private  java.lang.String nationality
          Nationality code of user.
private  java.lang.String postcode
          Part postcode of user, ie user will match if their postcode starts with this string.
private  com.RuntimeCollective.webapps.SearchResults results
          Results of the search.
private  int role
          Role of user.
private  boolean startsOnly
          StartsOnly: if true we look for like 'xxx%' rather than '%xxx%'.
private  java.lang.String surname
          Surname of user.
 
Fields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet
 
Constructor Summary
SearchUserForm()
           
 
Method Summary
 void excludeArchivedTrackedUsers()
           
 boolean getAcceptsEmptyForm()
          Get acceptsEmptyForm.
 java.lang.String getCity()
          Get city of user.
 java.lang.String getCountry()
          Get country code of user.
 java.lang.String getDescription()
          Get a String description of the class of users returned, eg "users whose name start with XXX and ...".
 java.lang.String getEmail()
          Get email part of user.
 java.lang.String getFirstName()
          Get first name of user.
 int getGroupId()
          Get groupId.
 java.lang.String getLastName()
          Get surname of user.
 java.lang.String getNationality()
          Get nationality code of user.
 java.lang.String getPostcode()
          Get postcode of user.
 com.RuntimeCollective.webapps.SearchResults getResults()
          Get results.
 int getRole()
          Get role.
 boolean getStartsOnly()
          Get startsOnly.
protected static boolean isEmpty(java.lang.String string)
           
 void reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
          Reset all properties to their default values.
 void setAcceptsEmptyForm(boolean acceptsEmptyForm)
          Set acceptsEmptyForm.
 void setCity(java.lang.String city)
          Set city of user.
 void setCountry(java.lang.String country)
          Set country code of user.
 void setEmail(java.lang.String email)
          Set email part of user.
 void setFirstName(java.lang.String first)
          Set first name of user.
 void setGroupId(int groupId)
          Set groupId.
 void setLastName(java.lang.String surname)
          Set surname of user.
 void setNationality(java.lang.String nationality)
          Set nationality code of user.
 void setPostcode(java.lang.String postcode)
          Set postcode of user.
 void setResults(com.RuntimeCollective.webapps.SearchResults results)
          Set results.
 void setRole(int role)
          Set role.
 void setStartsOnly(boolean startsOnly)
          Set startsOnly.
 org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
          Validate search criteria.
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

surname

private java.lang.String surname
Surname of user.

first

private java.lang.String first
First name of user.

email

private java.lang.String email
Part of the Email of user -- ie user will match if their email address contains this string.

nationality

private java.lang.String nationality
Nationality code of user.

postcode

private java.lang.String postcode
Part postcode of user, ie user will match if their postcode starts with this string.

city

private java.lang.String city
City of user.

country

private java.lang.String country
Country code of residence of user.

role

private int role
Role of user.

groupId

private int groupId
The id of a group the user belongs to.

results

private com.RuntimeCollective.webapps.SearchResults results
Results of the search.

acceptsEmptyForm

private boolean acceptsEmptyForm
AcceptsEmptyForm: if true we let pass empty forms (thus returning all users).

startsOnly

private boolean startsOnly
StartsOnly: if true we look for like 'xxx%' rather than '%xxx%'.

Constructor Detail

SearchUserForm

public SearchUserForm()
Method Detail

setLastName

public void setLastName(java.lang.String surname)
Set surname of user.

getLastName

public java.lang.String getLastName()
Get surname of user.

setFirstName

public void setFirstName(java.lang.String first)
Set first name of user.

getFirstName

public java.lang.String getFirstName()
Get first name of user.

setEmail

public void setEmail(java.lang.String email)
Set email part of user.

getEmail

public java.lang.String getEmail()
Get email part of user.

setNationality

public void setNationality(java.lang.String nationality)
Set nationality code of user.

getNationality

public java.lang.String getNationality()
Get nationality code of user.

setPostcode

public void setPostcode(java.lang.String postcode)
Set postcode of user.

getPostcode

public java.lang.String getPostcode()
Get postcode of user.

setCity

public void setCity(java.lang.String city)
Set city of user.

getCity

public java.lang.String getCity()
Get city of user.

setCountry

public void setCountry(java.lang.String country)
Set country code of user.

getCountry

public java.lang.String getCountry()
Get country code of user.

setRole

public void setRole(int role)
Set role.

getRole

public int getRole()
Get role.

setGroupId

public void setGroupId(int groupId)
Set groupId.

getGroupId

public int getGroupId()
Get groupId.

setResults

public void setResults(com.RuntimeCollective.webapps.SearchResults results)
Set results.

getResults

public com.RuntimeCollective.webapps.SearchResults getResults()
Get results.

setAcceptsEmptyForm

public void setAcceptsEmptyForm(boolean acceptsEmptyForm)
Set acceptsEmptyForm.

getAcceptsEmptyForm

public boolean getAcceptsEmptyForm()
Get acceptsEmptyForm.

setStartsOnly

public void setStartsOnly(boolean startsOnly)
Set startsOnly.

getStartsOnly

public boolean getStartsOnly()
Get startsOnly.

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)
Reset all properties to their default values. NB this ONLY clears the form properties, not the results.

validate

public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping,
                                                      javax.servlet.http.HttpServletRequest request)
Validate search criteria. Returns error with code=error.userSearch.null if no criteria entered.

getDescription

public java.lang.String getDescription()
Get a String description of the class of users returned, eg "users whose name start with XXX and ...". FIXME: need to implement role, nationality, group.

isEmpty

protected static boolean isEmpty(java.lang.String string)

excludeArchivedTrackedUsers

public void excludeArchivedTrackedUsers()
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> RuntimeCollective >> webapps >> [ form overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.RuntimeCollective.webapps.form.SearchUserForm JAVADOC | Sourc code of com.RuntimeCollective.webapps.form.SearchUserForm SOURCE | Download com.RuntimeCollective.webapps.form.SearchUserForm DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD