|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.webmethods.caf.faces.bean.PageFlowScopeAdapter
com.webmethods.caf.faces.data.object.ListTableContentProvider
com.webmethods.caf.faces.data.object.SelectableListTableContentProvider
com.webmethods.caf.faces.data.dir.PeopleSearchProvider
public class PeopleSearchProvider
Search Provider for searching on users/groups/roles principles The provider extends a list Table content provider.
Nested Class Summary | |
---|---|
class |
PeopleSearchProvider.DirectoryPagingIterator
Paging iterator from directory service. |
protected class |
PeopleSearchProvider.PrincipalSortComparator
Comparator that simply reverses the result of a standard compare (for descending key sorts) |
protected class |
PeopleSearchProvider.SortEntry
Sort utility class. |
Nested classes/interfaces inherited from class com.webmethods.caf.faces.data.object.SelectableListTableContentProvider |
---|
SelectableListTableContentProvider.Row, SelectableListTableContentProvider.RowComparator |
Field Summary | |
---|---|
protected List |
fExcludePrincipalsList
|
protected ISearchQuery |
fSearchQuery
|
Fields inherited from class com.webmethods.caf.faces.data.object.SelectableListTableContentProvider |
---|
m_autoIdCounter, m_map, m_originalList, m_selectableHelper |
Fields inherited from class com.webmethods.caf.faces.data.object.ListTableContentProvider |
---|
m_array, m_canTemplateRow, m_index, m_list, m_onCreateRow, m_onDeleteRow, m_rowId, m_rowType, m_sort, m_templateRow, m_var |
Fields inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter |
---|
fExpireWithPageFlow |
Constructor Summary | |
---|---|
PeopleSearchProvider()
Default constructor that sets the row variable and row Id binding for the selectable list table content provider parent class. |
Method Summary | |
---|---|
protected boolean |
filterPrincipalByAttribute(IDirPrincipal dirPrincipal,
PrincipalAttributeValueSource papValueSrc,
List attribFilterRegexList)
Filter the principal by its attributes. |
protected int |
getAsInt(Object o,
int defaultValue)
Get an integer for the object or use the default value. |
protected String |
getAsString(Object o,
String defaultValue)
Get a String for the object or use the default value. |
String |
getDirService()
Get the directory service for the search query. |
Integer |
getMaxResults()
Get the maximum number of results allowed in the search results. |
String |
getQueryString()
Deprecated. Use field on fSearchQuery instead. |
ISearchQuery |
getSearchQuery()
Initialize and cache the search query from the default search query factory. |
Integer |
getSearchType()
Get the principal type to search for. |
static String |
getSortValue(Object obj,
String propertyExpression)
Get the value of the property used to sort the principal. |
protected boolean |
isPrincipleExcluded(IDirPrincipal principal)
Is the directory principal in the list of excluded principals. |
protected boolean |
isPrincipleExcluded(IURI principalURI)
Is the principal URI in the list of excluded principals. |
void |
refresh()
Refresh the list of search results. |
void |
setDirService(String dirService)
Set the directory service in the search query. |
void |
setExcludePrincipalsList(List excludePrincipalsList)
Set the list of principals to exclude. |
void |
setMaxResults(Integer maxResults)
Deprecated. Use field on fSearchQuery instead. |
void |
setQueryString(String queryString)
Deprecated. Use field on fSearchQuery instead. |
void |
setSearchQuery(ISearchQuery searchQuery)
Manually set the search query. |
void |
setSearchType(Integer searchType)
Set the principal type to search for. |
void |
setSort(ISortInfo sort)
Set the sort information for this provider. |
protected void |
sort()
Sort is handled by the refresh method. |
Methods inherited from class com.webmethods.caf.faces.data.object.SelectableListTableContentProvider |
---|
createRow, deleteRow, getCurrentRow, getList, getNeedRefresh, getRowId, getRowSelectedCount, getRowSelectedIds, getRowUnselectedIds, getSelectedRows, getUseUnselectedModel, isAddressable, isAutoRefresh, isRowSelected, moveTo, setAutoRefresh, setCurrentRow, setList, setNeedRefresh, setRowById, setRowSelected, setRowSelectedIds, setRowUnselectedIds, setRowVariable, setTemplateRow, supportsAutoRefresh, updateOriginalList |
Methods inherited from class com.webmethods.caf.faces.data.object.ListTableContentProvider |
---|
calculateRowId, calculateRowId, getArray, getCanTemplateRow, getOnCreateRow, getOnDeleteRow, getPropertyKeys, getRowCount, getRowIdBinding, getRowIndex, getRowType, getRowVariable, getSort, getType, getValue, hasProperty, isReadOnly, isReorderable, isRowAvailable, isTemplateRow, newRow, setArray, setCanTemplateRow, setOnCreateRow, setOnDeleteRow, setRowId, setRowIdBinding, setRowIndex, setRowType, setValue, toString |
Methods inherited from class com.webmethods.caf.faces.bean.PageFlowScopeAdapter |
---|
getExpireWithPageFlow, setExpireWithPageFlow |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.webmethods.caf.faces.data.ITableContentProvider |
---|
getRowCount, getRowIndex, getRowVariable, isRowAvailable, setRowIndex |
Methods inherited from interface com.webmethods.caf.faces.data.IContentProvider |
---|
getPropertyKeys, getType, getValue, hasProperty, toString |
Field Detail |
---|
protected List fExcludePrincipalsList
protected ISearchQuery fSearchQuery
Constructor Detail |
---|
public PeopleSearchProvider()
ListTableContentProvider.setRowIdBinding(ValueBinding)
,
SelectableListTableContentProvider.setRowVariable(String)
Method Detail |
---|
public ISearchQuery getSearchQuery()
DefaultSearchQueryFactory#createSearchQuery()
public void setSearchQuery(ISearchQuery searchQuery)
searchQuery
- The searchQuery to setpublic String getDirService()
public void setDirService(String dirService)
dirService
- The dirService to set.public Integer getMaxResults()
public void setMaxResults(Integer maxResults)
maxResults
- The maxResults to set.public String getQueryString()
ISearchQuery.getKeywordField()
public void setQueryString(String queryString)
queryString
- the queryString to set.ISearchQuery.getKeywordField()
public Integer getSearchType()
IDirConstants.TYPE_USER
, IDirConstants.TYPE_ROLE
, or IDirConstants.TYPE_GROUP
.public void setSearchType(Integer searchType)
searchType
- The searchType is null, IDirConstants.TYPE_USER
, IDirConstants.TYPE_ROLE
, or IDirConstants.TYPE_GROUP
.public void setExcludePrincipalsList(List excludePrincipalsList)
excludePrincipalsList
- the excludePrincipalsList to setprotected void sort()
sort
in class SelectableListTableContentProvider
ListTableContentProvider.setSort(ISortInfo)
public void setSort(ISortInfo sort)
setSort
in interface ISortableTableContentProvider
setSort
in class ListTableContentProvider
sort
- The table sort information.ListTableContentProvider.setSort(com.webmethods.caf.faces.data.ISortInfo)
protected boolean isPrincipleExcluded(IURI principalURI) throws PortalException
principalURI
- The principal URI to check.
PortalException
protected boolean isPrincipleExcluded(IDirPrincipal principal) throws PortalException
principal
- The directory principal to check.
PortalException
public void refresh()
refresh
in interface IRefreshable
refresh
in class SelectableListTableContentProvider
SelectableListTableContentProvider.refresh()
protected boolean filterPrincipalByAttribute(IDirPrincipal dirPrincipal, PrincipalAttributeValueSource papValueSrc, List attribFilterRegexList) throws PortalException
dirPrincipal
- papValueSrc
- The value sourceattribFilterRegexList
- The regex list to filter the attribute value.
PortalException
public static String getSortValue(Object obj, String propertyExpression)
obj
- The target to evaluate.propertyExpression
- The value expression (ie '{name}').protected String getAsString(Object o, String defaultValue)
o
- defaultValue
- The value to return if o is null.
protected int getAsInt(Object o, int defaultValue)
o
- defaultValue
- The value to return if o is not a String or Integer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |