Package com.softwareag.caf.controls.mwsx

Class PeopleSearchBarBean

java.lang.Object

com.webmethods.caf.faces.bean.BaseFacesBean

com.webmethods.caf.faces.bean.BaseFacesSessionBean

com.webmethods.caf.faces.bean.BaseViewBean

com.webmethods.caf.faces.bean.BaseCompositeViewControlPageBean

com.webmethods.caf.faces.component.search.view.SearchBarControlBean

com.softwareag.caf.controls.mwsx.PeopleSearchBarBean

All Implemented Interfaces:

IPageFlowScopeAdapter, ICompositeViewControlPageBean, ISearchBarPageBean, Serializable, EventListener, PhaseListener, HttpSessionBindingListener

public class PeopleSearchBarBean
extends SearchBarControlBean
implements ISearchBarPageBean

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.webmethods.caf.faces.bean.BaseViewBean

BaseViewBean.ClientIdsContentProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected ISelectItemGroupProvider	fAvailableDirectories
protected PrincipalAttributeValueSourceSelectItemGroupProvider	fGroupAdvancedAttrItemProvider
protected PrincipalAttributeValueSourceSelectItemGroupProvider	fRoleAdvancedAttrItemProvider
protected SelectItem[]	fStaticRoleAttributeItems
protected PrincipalAttributeValueSourceSelectItemGroupProvider	fUserAdvancedAttrItemProvider
protected Boolean	isGroupSearchAllowed
protected Boolean	isRoleSearchAllowed
protected Boolean	isUserSearchAllowed

Fields inherited from class com.webmethods.caf.faces.component.search.view.SearchBarControlBean

CONTROL_ID_INITIAL_SEARCHTAB_DROPDOWN, CONTROL_ID_KEYWORDS_TEXT_INPUT, CONTROL_ID_MAX_RESULTS, CONTROL_ID_REFINED_SEARCH_ASYNC_GO_BUTTON, CONTROL_ID_REFINED_SEARCH_GO_BUTTON, CONTROL_ID_SAVE_SEARCH_ASYNC_GO_BUTTON, CONTROL_ID_SAVE_SEARCH_GO_BUTTON, CONTROL_ID_SAVE_SEARCH_OPTIONS_BUTTON, CONTROL_ID_SAVED_SEARCHES_DROPDOWN, CONTROL_ID_SIMPLE_SEARCH_ASYNC_GO_BUTTON, CONTROL_ID_SIMPLE_SEARCH_GO_BUTTON, CONTROL_ID_SIMPLE_SUBMIT_BUTTONS_PANEL, fActiveSavedSearch, fActiveSearchQuery, fActiveTabValue, fAdvancedSearchAvailable, fAsyncGoRefresh, fClearFormButtonAvailable, fCurrentSearchOptions, fEncodersBean, fKeywordsFieldAvailable, fMaxResultsFieldAvailable, fMaxResultsMaxValue, fNeedsUserOptionsApplied, fPreviousTabValue, fRandomNumberGenerator, fRefineSearchButtonAvailable, fResultSearchQuery, fSavedSearchProvider, fSaveSearchAvailable, fSaveSearchCompleted, fSearchOptionsManager, fSearchQueryFactory, fSimpleSearchAvailable, fUseAsyncGoButton, fUseOrConditionAvailable, fUserSearchOptionsAvailable, TAB_VALUE_ADVANCED_SEARCH, TAB_VALUE_SAVED_SEARCHES, TAB_VALUE_SEARCH_OPTIONS, TAB_VALUE_SIMPLE_SEARCH

Fields inherited from class com.webmethods.caf.faces.bean.BaseCompositeViewControlPageBean

fCompositeNamingContainer

Fields inherited from class com.webmethods.caf.faces.bean.BaseViewBean

clientIds, initialized

Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean

fExpireWithPageFlow

Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesBean

DATA_BINDING_CLIENTS, EMPTY_RESOURCES, OUTCOME_ERROR, OUTCOME_OK, resourcesProviders

Constructor Summary

Constructors

Constructor	Description
PeopleSearchBarBean()

Method Summary

Modifier and Type	Method	Description
protected void	beforeInvokeApplication()	Clients should overwrite this method to perform custom actions before an action method is invoked.
String	clearSearchForm()	Action Handler for the 'Clear' button on all tabs of the SearchBar control
protected String	getActiveQueryStateString()
ISelectItemGroupProvider	getAvailableDirectories()
List<PeopleSearchFilter>	getDirSearchFilterList()
SelectableListTableContentProvider	getDirSearchFilterListProvider()
PrincipalAttributeValueSourceSelectItemGroupProvider	getExtAttributeItemGroup()
protected PrincipalAttributeValueSourceSelectItemGroupProvider	getGroupAttributeItemGroup()
protected PrincipalAttributeValueSourceSelectItemGroupProvider	getRoleAttributeItemGroup()
HtmlSelectOne	getSearchForType()	Getter method for the control with id='htmlForm:searchForType'
SelectItem[]	getStaticRoleAttributeItems()
protected PrincipalAttributeValueSourceSelectItemGroupProvider	getUserAttributeItemGroup()
boolean	isCurrentSearchAdvanced()
boolean	isGroupSearchAllowed()
boolean	isMultiSearchForType()
boolean	isRoleSearchAllowed()
boolean	isUserSearchAllowed()
void	loadSearchQueryDefaults(ISearchQuery query)	Page bean may load default values into search query object
String	refreshStackCommand_action()	Action Event Handler for the control with id='refreshStackCommand'
void	setAvailableDirectories(ISelectItemGroupProvider avDirs)
void	setGroupSearchAllowed(boolean isGroupSearchAllowed)
void	setRoleSearchAllowed(boolean isRoleSearchAllowed)
void	setUserSearchAllowed(boolean isUserSearchAllowed)

Methods inherited from class com.webmethods.caf.faces.component.search.view.SearchBarControlBean

addInfoMessage, afterRenderResponse, applySearchOptionPreferences, beforeRenderResponse, cancelSearchOptions, changeActiveSavedSearch, constructSearchQueryString, createSearchStateOptions, createSearchStateOptions, deleteSavedSearch, getActiveQueryStateString, getActiveSavedSearch, getActiveSearchQuery, getActiveTabValue, getAsyncGoRefresh, getCategorizedSavedSearches, getCurrentSearchOptions, getDefaultCommandId, getDefaultFocusId, getEncodersBean, getInitialSearchTab, getInitialSelectedSavedSearch, getMaxResultsMaxValue, getResultSearchQuery, getRunSearchOnDisplay, getSavedSearchProvider, getSaveSearchCompleted, getSearchOptionsManager, getSearchQueryFactory, getSimpleSearchRefinedTabText, getSimpleSearchTabText, isAdvancedSearchAvailable, isClearFormButtonAvailable, isKeywordsBlockVisible, isKeywordsFieldAvailable, isMaxResultsFieldAvailable, isRefinePanelVisible, isRefineSearchButtonAvailable, isSavedSearchesEmpty, isSaveSearchAvailable, isSearchBarOnAdvancedTab, isSearchBarOnOptionsTab, isSearchBarOnSavedTab, isSearchBarOnSimpleTab, isShowingSavedDetails, isSimpleSearchAvailable, isSimpleSearchRefining, isUseAsyncGoButton, isUseOrConditionAvailable, isUserSearchOptionsAvailable, persistSearchOptions, reset, saveSearchQuery, setActiveSavedSearch, setActiveSearchQuery, setActiveTabValue, setAdvancedSearchAvailable, setAsyncGoRefresh, setClearFormButtonAvailable, setEncodersBean, setKeywordsFieldAvailable, setLastSearchState, setMaxResultsFieldAvailable, setMaxResultsMaxValue, setRefinePanelVisible, setRefineSearchButtonAvailable, setSavedSearchProvider, setSaveSearchAvailable, setSaveSearchCompleted, setSearchOptionsManager, setSearchQueryFactory, setShowingSavedDetails, setSimpleSearchAvailable, setSimpleSearchRefining, setupVisibleControls, setUseAsyncGoButton, setUseOrConditionAvailable, setUserSearchOptionsAvailable, updateSavedSearchQuery

Methods inherited from class com.webmethods.caf.faces.bean.BaseCompositeViewControlPageBean

findComponentInRoot, getClientIds, getCompositeViewAbsoluteControlId, getCompositeViewControlId, getCompositeViewNamingContainer, getPropertyOrBindingValue, setCompositeViewNamingContainer

Methods inherited from class com.webmethods.caf.faces.bean.BaseViewBean

afterApplyRequestValues, afterInvokeApplication, afterPhase, afterProcessValidations, afterRestoreView, afterUpdateModelValues, beforeApplyRequestValues, beforePhase, beforeProcessValidations, beforeRestoreView, beforeUpdateModelValues, callInitialize, findComponent, getApplicationScope, getPhaseId, getRealPath, getRequestParam, getRequestScope, getSessionScope, gotoPage, gotoPage, initialize, isAsyncRequest, preRenderResponse, release, resetPageFlowStorage, streamFileDataToResponse

Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean

getExpireWithPageFlow, setExpireWithPageFlow, valueBound, valueUnbound

Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesBean

createMethodBinding, createMethodExpression, createValueBinding, createValueExpression, createValueExpression, error, error, error, error, error, getBean, getFacesContext, getLocale, getResourceInputStream, getResources, getResourcesProvider, getRootCause, getStackTrace, getTreeAttribute, isUserInRole, log, log, log, putTreeAttribute, resetDataBindingClients, resolveDataBinding, resolveDataBinding, resolveExpression, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.webmethods.caf.faces.search.query.ISearchBarPageBean

getSavedSearchProvider, getSearchOptionsManager, getSearchQueryFactory

Field Details

fAvailableDirectories

protected ISelectItemGroupProvider fAvailableDirectories

fUserAdvancedAttrItemProvider

protected PrincipalAttributeValueSourceSelectItemGroupProvider fUserAdvancedAttrItemProvider

fGroupAdvancedAttrItemProvider

protected PrincipalAttributeValueSourceSelectItemGroupProvider fGroupAdvancedAttrItemProvider

fRoleAdvancedAttrItemProvider

protected PrincipalAttributeValueSourceSelectItemGroupProvider fRoleAdvancedAttrItemProvider

isUserSearchAllowed

protected Boolean isUserSearchAllowed

isGroupSearchAllowed

protected Boolean isGroupSearchAllowed

isRoleSearchAllowed

protected Boolean isRoleSearchAllowed

fStaticRoleAttributeItems

protected SelectItem[] fStaticRoleAttributeItems

Constructor Details

PeopleSearchBarBean

public PeopleSearchBarBean()

Method Details

getDirSearchFilterList

public List<PeopleSearchFilter> getDirSearchFilterList()

getActiveQueryStateString

protected String getActiveQueryStateString()

Overrides:

getActiveQueryStateString in class SearchBarControlBean

beforeInvokeApplication

protected void beforeInvokeApplication()

Description copied from class: BaseViewBean

Clients should overwrite this method to perform custom actions before an action method is invoked.

Overrides:

beforeInvokeApplication in class SearchBarControlBean

isUserSearchAllowed

public boolean isUserSearchAllowed()

setUserSearchAllowed

public void setUserSearchAllowed(boolean isUserSearchAllowed)

isGroupSearchAllowed

public boolean isGroupSearchAllowed()

setGroupSearchAllowed

public void setGroupSearchAllowed(boolean isGroupSearchAllowed)

isRoleSearchAllowed

public boolean isRoleSearchAllowed()

setRoleSearchAllowed

public void setRoleSearchAllowed(boolean isRoleSearchAllowed)

isMultiSearchForType

public boolean isMultiSearchForType()

loadSearchQueryDefaults

public void loadSearchQueryDefaults(ISearchQuery query)

Description copied from interface: ISearchBarPageBean

Page bean may load default values into search query object

Specified by:

loadSearchQueryDefaults in interface ISearchBarPageBean

setAvailableDirectories

public void setAvailableDirectories(ISelectItemGroupProvider avDirs)

getAvailableDirectories

public ISelectItemGroupProvider getAvailableDirectories()

isCurrentSearchAdvanced

public boolean isCurrentSearchAdvanced()

getUserAttributeItemGroup

protected PrincipalAttributeValueSourceSelectItemGroupProvider getUserAttributeItemGroup()

getGroupAttributeItemGroup

protected PrincipalAttributeValueSourceSelectItemGroupProvider getGroupAttributeItemGroup()

getRoleAttributeItemGroup

protected PrincipalAttributeValueSourceSelectItemGroupProvider getRoleAttributeItemGroup()

getStaticRoleAttributeItems

public SelectItem[] getStaticRoleAttributeItems()

getExtAttributeItemGroup

public PrincipalAttributeValueSourceSelectItemGroupProvider getExtAttributeItemGroup()

refreshStackCommand_action

public String refreshStackCommand_action()

Action Event Handler for the control with id='refreshStackCommand'

getSearchForType

public HtmlSelectOne getSearchForType()

Getter method for the control with id='htmlForm:searchForType'

getDirSearchFilterListProvider

public SelectableListTableContentProvider getDirSearchFilterListProvider()

clearSearchForm

public String clearSearchForm()

Description copied from class: SearchBarControlBean

Action Handler for the 'Clear' button on all tabs of the SearchBar control

Overrides:

clearSearchForm in class SearchBarControlBean

Returns:

outcome of the action handler