public class DirectorySearchProvider extends SelectableListTableContentProvider
Modifier and Type | Class and Description |
---|---|
class |
DirectorySearchProvider.DirectoryPagingIterator
Paging iterator from directory service.
|
protected class |
DirectorySearchProvider.SortEntry
Sort utility class.
|
SelectableListTableContentProvider.Row, SelectableListTableContentProvider.RowComparator
Modifier and Type | Field and Description |
---|---|
protected String |
fDirService |
protected List<IPrincipalProvider> |
fExcludePrincipalsList |
protected Integer |
fMaxResults |
protected String |
fQueryString |
protected Integer |
fSearchType |
m_autoIdCounter, m_map, m_originalList, m_selectableHelper
m_array, m_canTemplateRow, m_index, m_list, m_onCreateRow, m_onDeleteRow, m_rowId, m_rowType, m_sort, m_templateRow, m_var
fExpireWithPageFlow
Constructor and Description |
---|
DirectorySearchProvider()
Default constructor that sets the row variable and row Id binding
for the selectable list table content provider parent class.
|
Modifier and Type | Method and Description |
---|---|
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.
|
protected IThingIDList |
getDirectoryServices()
Get the directory services from the portal system.
|
String |
getDirService()
Get the directory service for the search query.
|
Integer |
getMaxResults()
Set the directory service in the search query.
|
String |
getQueryString()
Deprecated.
Use field on fSearchQuery instead
|
Integer |
getSearchType()
Get the search 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<IPrincipalProvider> excludePrincipalsList)
Set the list of principal to exclude.
|
void |
setMaxResults(Integer maxResults)
Deprecated.
Use field on fSearchQuery instead.
|
void |
setQueryString(String queryString)
Deprecated.
use field on fSearchQuery instead
|
void |
setSearchType(Integer searchType)
Set the search type to
IDirConstants.TYPE_USER , IDirConstants.TYPE_ROLE , or IDirConstants.TYPE_GROUP . |
void |
setSort(ISortInfo sort)
Set the sort information for this provider.
|
protected void |
sort()
Sort is handled by the refresh method.
|
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
calculateRowId, calculateRowId, getArray, getCanTemplateRow, getOnCreateRow, getOnCreateRowExpression, getOnDeleteRow, getOnDeleteRowExpression, getPropertyKeys, getRowCount, getRowIdBinding, getRowIdExpression, getRowIndex, getRowType, getRowVariable, getSort, getType, getValue, hasProperty, isReadOnly, isReorderable, isRowAvailable, isTemplateRow, newRow, setArray, setCanTemplateRow, setOnCreateRow, setOnCreateRowExpression, setOnDeleteRow, setOnDeleteRowExpression, setRowId, setRowIdBinding, setRowIdExpression, setRowIndex, setRowType, setValue, toString
getExpireWithPageFlow, setExpireWithPageFlow
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getRowCount, getRowIndex, getRowVariable, isRowAvailable, setRowIndex
getPropertyKeys, getType, getValue, hasProperty, toString
protected Integer fMaxResults
protected Integer fSearchType
protected String fDirService
protected String fQueryString
protected List<IPrincipalProvider> fExcludePrincipalsList
public DirectorySearchProvider()
public String getDirService()
public void setDirService(String dirService)
dirService
- The dirService to set.public Integer getMaxResults()
dirService
- The dirService to set.public void setMaxResults(Integer maxResults)
maxResults
- The maxResults to set.public String getQueryString()
public void setQueryString(String queryString)
queryString
- the queryString to setpublic Integer getSearchType()
IDirConstants.TYPE_USER
, IDirConstants.TYPE_ROLE
, or IDirConstants.TYPE_GROUP
.public void setSearchType(Integer searchType)
IDirConstants.TYPE_USER
, IDirConstants.TYPE_ROLE
, or IDirConstants.TYPE_GROUP
.searchType
- The search type to set.public void setExcludePrincipalsList(List<IPrincipalProvider> 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()
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.protected IThingIDList getDirectoryServices() throws PortalException
PortalException