Package com.webmethods.caf.faces.data.task.impl

Class TaskInboxSearchContentProvider

java.lang.Object

com.webmethods.caf.faces.bean.PageFlowScopeAdapter

com.webmethods.caf.faces.data.object.ListTableContentProvider

com.webmethods.caf.faces.data.object.SelectableListTableContentProvider

com.webmethods.caf.faces.data.task.impl.TaskSearchContentProvider

com.webmethods.caf.faces.data.task.impl.TaskInboxSearchContentProvider

All Implemented Interfaces:

IPageFlowScopeAdapter, IAddressableTableContentProvider, IContentProvider, IRefreshable, IRefreshableContentProvider, IReorderableTableContentProvider, ISelectableTableContentProvider, ISortableTableContentProvider, ITableContentProvider, IUpdateableContentProvider, IUpdateableTableContentProvider, ITaskSearchContentProvider, Serializable

public class TaskInboxSearchContentProvider
extends TaskSearchContentProvider

Extends base provider class which implements task non-indexed searches by adding a default search query for custom inbox This search query implements some pre-defined set of search terms typically used. When task custom inbox is implemented this class is typically extended to add more search terms

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TaskInboxSearchContentProvider.InboxSearchQuery

Nested classes/interfaces inherited from class com.webmethods.caf.faces.data.object.SelectableListTableContentProvider

SelectableListTableContentProvider.Row, SelectableListTableContentProvider.RowComparator

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_currentPageIndex	Tracks the current displayed table page so we can reset it when search refreshes
protected DateFormat	m_formatter
protected String	taskTypeID	Task Type ID to search

Fields inherited from class com.webmethods.caf.faces.data.task.impl.TaskSearchContentProvider

m_includeTaskData, m_isAutoRefresh, m_needRefresh, m_results, m_resultsTotalCount, m_searchInbox, m_searchQuery, PROPERTY_TASKDATA

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

Constructors

Constructor	Description
TaskInboxSearchContentProvider()
TaskInboxSearchContentProvider(String taskTypeID)

Method Summary

Modifier and Type	Method	Description
int	getCurrentPageIndex()	Returns current search results page index
String[]	getPrincipalUIDsFromModelList(List<IPrincipalProvider> principalList)	Helper method to convert list of principal model objects into array of principal names
TaskInboxSearchContentProvider.InboxSearchQuery	getSearchQuery()	Typed custom search query
void	refresh()	Should be called by the clients when the wrapped list objects gets changed outside this provider.
void	setCurrentPageIndex(int currentPageIndex)	Sets current search results page index

Methods inherited from class com.webmethods.caf.faces.data.task.impl.TaskSearchContentProvider

calculateRowId, getNeedRefresh, getPropertyKeys, getResults, getResultsTotalCount, getSearchInbox, getTaskInfo, getTaskSearchQueryV2, getTotalCount, getType, getValue, hasProperty, isAutoRefresh, refreshTotalCount, refreshTotalCount, setAutoRefresh, setNeedRefresh, setSearchInbox, supportsAutoRefresh

Methods inherited from class com.webmethods.caf.faces.data.object.SelectableListTableContentProvider

createRow, deleteRow, getCurrentRow, getList, getRowId, getRowSelectedCount, getRowSelectedIds, getRowUnselectedIds, getSelectedRows, getUseUnselectedModel, isAddressable, isRowSelected, moveTo, setCurrentRow, setList, setRowById, setRowSelected, setRowSelectedIds, setRowUnselectedIds, setRowVariable, setTemplateRow, sort, updateOriginalList

Methods inherited from class com.webmethods.caf.faces.data.object.ListTableContentProvider

calculateRowId, getArray, getCanTemplateRow, getOnCreateRow, getOnCreateRowExpression, getOnDeleteRow, getOnDeleteRowExpression, getRowCount, getRowIdBinding, getRowIdExpression, getRowIndex, getRowType, getRowVariable, getSort, isReadOnly, isReorderable, isRowAvailable, isTemplateRow, newRow, setArray, setCanTemplateRow, setOnCreateRow, setOnCreateRowExpression, setOnDeleteRow, setOnDeleteRowExpression, setRowId, setRowIdBinding, setRowIdExpression, setRowIndex, setRowType, setSort, 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.IContentProvider

toString

Methods inherited from interface com.webmethods.caf.faces.data.ITableContentProvider

getCurrentRow, getRowCount, getRowIndex, getRowVariable, isRowAvailable, setRowIndex, setRowVariable

Field Details

m_currentPageIndex

protected int m_currentPageIndex

Tracks the current displayed table page so we can reset it when search refreshes

m_formatter

protected DateFormat m_formatter

taskTypeID

protected String taskTypeID

Task Type ID to search

Constructor Details

TaskInboxSearchContentProvider

public TaskInboxSearchContentProvider()

TaskInboxSearchContentProvider

public TaskInboxSearchContentProvider(String taskTypeID)

Method Details

refresh

public void refresh()

Description copied from class: SelectableListTableContentProvider

Should be called by the clients when the wrapped list objects gets changed outside this provider.

Specified by:

refresh in interface IRefreshable

Overrides:

refresh in class TaskSearchContentProvider

getSearchQuery

public TaskInboxSearchContentProvider.InboxSearchQuery getSearchQuery()

Typed custom search query

Overrides:

getSearchQuery in class TaskSearchContentProvider

getPrincipalUIDsFromModelList

public String[] getPrincipalUIDsFromModelList(List<IPrincipalProvider> principalList)

Helper method to convert list of principal model objects into array of principal names

Parameters:

principalList - list of principal model objects

Returns:

array of principal names

getCurrentPageIndex

public int getCurrentPageIndex()

Returns current search results page index

Returns:

current page index

setCurrentPageIndex

public void setCurrentPageIndex(int currentPageIndex)

Sets current search results page index

Parameters:

currentPageIndex -