com.atlassian.confluence.user.actions
Class AbstractSearchUsersAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport
          com.atlassian.confluence.user.actions.AbstractEntityPaginationAction
              com.atlassian.confluence.user.actions.AbstractSearchUsersAction

All Implemented Interfaces:

Tabbed, WebInterface, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

Direct Known Subclasses:

SearchUsersAction, UserPickerAction

public abstract class AbstractSearchUsersAction
extends AbstractEntityPaginationAction
implements Tabbed

Base class for actions that do some kind of searching for users. Search actions that are admin restricted should extend

See Also:

SearchUsersAction, Serialized Form

Field Summary

protected com.atlassian.bandana.BandanaManager	bandanaManager
protected String	emailTerm
protected String	fullnameTerm
protected boolean	isLicensedToAddMoreUsers
protected LicenseService	licenseService
protected MailServerExistsCriteria	mailServerExistsCriteria
protected String	operator
protected int	resultsPerPage
protected List<com.atlassian.core.util.PairType>	resultsPerPageOptions
protected SearchEntitiesManager	searchEntitiesManager
protected String	searchTerm
protected String	selectedTab
static String	SHOW_ALL_SEARCH_TERM
protected boolean	supportsSimpleSearch
static String	TERM_DELIM_CHARS
protected static Comparator<com.atlassian.user.User>	USER_COMPARATOR
protected UserChecker	userChecker
protected String	usernameTerm
protected WritableDirectoryExistsCriteria	writableDirectoryExistsCriteria

Fields inherited from class com.atlassian.confluence.user.actions.AbstractEntityPaginationAction

paginationSupport

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

AbstractSearchUsersAction()

Method Summary

protected String	appendWildcard(String s)
String	doUserSearch()
String	getEmailTerm()
String	getFullnameTerm()
String	getLicenseErrorHtml()
String	getOperator()
List	getOperators()
int	getResultsPerPage()
List	getResultsPerPageOptions()
String	getSearchTerm()
String	getSelectedTab() Returns the key of the tab that should be selected when rendering.
String	getUsernameTerm()
boolean	isShowAll()
boolean	isSupportsSimpleSearch()
void	setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)
void	setEmailTerm(String emailTerm)
void	setFullnameTerm(String fullnameTerm)
void	setLicenseService(LicenseService licenseService)
void	setMailServerExistsCriteria(MailServerExistsCriteria mailServerExistsCriteria)
void	setOperator(String operator)
void	setResultsPerPage(int resultsPerPage) Change the pageSize
void	setSearchEntitiesManager(SearchEntitiesManager searchEntitiesManager)
void	setSearchTerm(String searchTerm)
void	setSelectedTab(String selectedTab)
void	setSupportsSimpleSearch(boolean supportsSimpleSearch)
void	setUserChecker(UserChecker userChecker)
void	setUsernameTerm(String usernameTerm)
void	setWritableDirectoryExistsCriteria(WritableDirectoryExistsCriteria writableDirectoryExistsCriteria)
void	validate()

Methods inherited from class com.atlassian.confluence.user.actions.AbstractEntityPaginationAction

getPaginationSupport, getStartIndex, setStartIndex

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getCancel, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserByName, getUserFullName, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermitted, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setApiDateFormatService, setBootstrapManager, setCancel, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, execute, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER_COMPARATOR

protected static final Comparator<com.atlassian.user.User> USER_COMPARATOR

TERM_DELIM_CHARS

public static final String TERM_DELIM_CHARS

See Also:

Constant Field Values

SHOW_ALL_SEARCH_TERM

public static final String SHOW_ALL_SEARCH_TERM

See Also:

Constant Field Values

resultsPerPageOptions

protected List<com.atlassian.core.util.PairType> resultsPerPageOptions

userChecker

protected UserChecker userChecker

bandanaManager

protected com.atlassian.bandana.BandanaManager bandanaManager

searchEntitiesManager

protected SearchEntitiesManager searchEntitiesManager

mailServerExistsCriteria

protected MailServerExistsCriteria mailServerExistsCriteria

writableDirectoryExistsCriteria

protected WritableDirectoryExistsCriteria writableDirectoryExistsCriteria

searchTerm

protected String searchTerm

usernameTerm

protected String usernameTerm

fullnameTerm

protected String fullnameTerm

emailTerm

protected String emailTerm

operator

protected String operator

resultsPerPage

protected int resultsPerPage

isLicensedToAddMoreUsers

protected boolean isLicensedToAddMoreUsers

supportsSimpleSearch

protected boolean supportsSimpleSearch

selectedTab

protected String selectedTab

licenseService

protected LicenseService licenseService

Constructor Detail

AbstractSearchUsersAction

public AbstractSearchUsersAction()

Method Detail

validate

public void validate()

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface com.opensymphony.xwork.Validateable

Overrides:

validate in class com.opensymphony.xwork.ActionSupport

getOperators

public List getOperators()

getSelectedTab

public String getSelectedTab()

Description copied from interface: Tabbed

Returns the key of the tab that should be selected when rendering. e.g. "search" or "create" for the browseusers.vm

Specified by:

getSelectedTab in interface Tabbed

setSelectedTab

public void setSelectedTab(String selectedTab)

doUserSearch

public String doUserSearch()

appendWildcard

protected String appendWildcard(String s)

isSupportsSimpleSearch

public boolean isSupportsSimpleSearch()

isShowAll

public boolean isShowAll()

setSupportsSimpleSearch

public void setSupportsSimpleSearch(boolean supportsSimpleSearch)

setSearchEntitiesManager

public void setSearchEntitiesManager(SearchEntitiesManager searchEntitiesManager)

setMailServerExistsCriteria

public void setMailServerExistsCriteria(MailServerExistsCriteria mailServerExistsCriteria)

setWritableDirectoryExistsCriteria

public void setWritableDirectoryExistsCriteria(WritableDirectoryExistsCriteria writableDirectoryExistsCriteria)

getResultsPerPage

public int getResultsPerPage()

getSearchTerm

public String getSearchTerm()

setSearchTerm

public void setSearchTerm(String searchTerm)

getUsernameTerm

public String getUsernameTerm()

setUsernameTerm

public void setUsernameTerm(String usernameTerm)

getFullnameTerm

public String getFullnameTerm()

setFullnameTerm

public void setFullnameTerm(String fullnameTerm)

getEmailTerm

public String getEmailTerm()

setEmailTerm

public void setEmailTerm(String emailTerm)

getOperator

public String getOperator()

setOperator

public void setOperator(String operator)

setBandanaManager

public void setBandanaManager(com.atlassian.bandana.BandanaManager bandanaManager)

getLicenseErrorHtml

public String getLicenseErrorHtml()

setResultsPerPage

public void setResultsPerPage(int resultsPerPage)

Change the pageSize

Parameters:

resultsPerPage - Number to show per page

getResultsPerPageOptions

public List getResultsPerPageOptions()

setLicenseService

public void setLicenseService(LicenseService licenseService)

setUserChecker

public void setUserChecker(UserChecker userChecker)