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

Class TaskIndexedSearchContentProvider

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.object.PageableTableContentProvider

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TaskInboxIndexedSearchContentProvider

public class TaskIndexedSearchContentProvider
extends PageableTableContentProvider
implements ITaskSearchPagingContentProvider

Content provider which implements Indexed Task searches and intended to be used as value for table controls in custom task inbox portlets

When using this provider class you need to configure its search query getSearchQuery() terms and call refresh() method. Most of the time this provider is extended when implementing custom task inbox by adding new search terms.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TaskIndexedSearchContentProvider.Task
class	TaskIndexedSearchContentProvider.TaskData
class	TaskIndexedSearchContentProvider.TaskSearchPagingService

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 boolean	m_includeTaskData	Flag that indicates if search result should include task business data
protected boolean	m_isAutoRefresh	Flag if provider is auto-refreshable
protected boolean	m_needRefresh	Flag to indicate if provider should be refreshed
protected List<ITaskSearchRecord>	m_NextResults	Stored current page results as list
protected int	m_pageSizing	Paging size
protected ITask[]	m_results	Current page results
protected boolean	m_searchInbox	Flag to indicate if provider should search for current user's inbox tasks only
protected TaskSearchQueryV2	m_searchQuery	Task Search Query object
protected TaskIndexedSearchContentProvider.TaskSearchPagingService	pagingService	Instance of back end service which implement task search
static final String	PROPERTY_TASKDATA
protected String	taskDataClassName	Stores task business data class name

Fields inherited from class com.webmethods.caf.faces.data.object.PageableTableContentProvider

array, arraySet, list, listSet, pageRowIndex, refreshPageBinding, rowCache, rowCount, table, tableSet

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
TaskIndexedSearchContentProvider()
TaskIndexedSearchContentProvider(TaskSearchQueryV2 searchQuery)	Constructor from task search query

Method Summary

Modifier and Type	Method	Description
protected String	calculateRowId(int index, Object data)	Return data.getTaskInfo().getTaskID() as RowId
boolean	getNeedRefresh()	Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.
List<ITaskSearchRecord>	getNextResults()	Returns results (task list) for the current page
int	getPagingSize()	Returns page size used for search
Object[]	getPropertyKeys()	Returns property keys for the current row object which is an element of the wrapped array or the list by ListTableContentProvider.getRowIndex() index.
ITask[]	getResults()	Returns results (task list) for the current page
boolean	getSearchInbox()	Returns boolean value indicates whether to search current user inbox or full task list return true if search current user inbox only
TaskSearchQueryV2	getSearchQuery()	Returns task search query
String	getTaskDataClassName()	Returns task business data class name
ITaskInfo	getTaskInfo()	Returns ITaskInfo task info for the current row
protected List<ITask>	getTaskList(List<ITaskSearchRecord> searchRecords)	Helper method to convert task search records into list of ITask objects
Class<?>	getType(Object propertyKey)	Returns java type of the given property
Object	getValue(Object propertyKey)	Returns value of the given property
boolean	hasProperty(Object propertyKey)	Checks if the given property is supported by this content provider
protected boolean	hasSearchInvocation()	Checks if provider is refreshed from the Search button invoke on the custom inbox page
boolean	isAutoRefresh()	Returns false
boolean	isIncludeTaskData()	Returns flag if search results should include indexed task business data
void	refresh()	Resets internal cache, rowCount and pageRowIndex.
void	refresh(boolean forSort)	Refresh the content of the provider.
void	refreshPage()	This refreshes data for current provider page.
void	setAutoRefresh(boolean autoRefresh)	Sets auto refresh mode on.
void	setIncludeTaskData(boolean taskData)	Sets flag if search results should include indexed task business data
void	setNeedRefresh(boolean needRefresh)	Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).
void	setPagingSize(int count)	Sets page size for search
void	setSearchInbox(boolean value)	Setting whether to search current user inbox or full task list
void	setSort(ISortInfo sort)	Sets new sort info, re-sorting the table (if necessary).
void	setTaskDataClassName(String className)	Sets task business data class name
protected void	sort()	(Re-)sorts list according to sort info.
boolean	supportsAutoRefresh()	Returns false

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

getArray, getList, getPageRowIndex, getRefreshPageBinding, getRefreshPageExpression, getRowCount, getTable, isRowAvailable, loadPageData, setArray, setList, setPageRowIndex, setRefreshPageBinding, setRefreshPageExpression, setRowCount, setTable

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

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

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

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

toString

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

getPageRowIndex, setPageRowIndex

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

getSort

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

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

Field Details

PROPERTY_TASKDATA

public static final String PROPERTY_TASKDATA

See Also:

• Constant Field Values

m_isAutoRefresh

protected boolean m_isAutoRefresh

Flag if provider is auto-refreshable

m_needRefresh

protected boolean m_needRefresh

Flag to indicate if provider should be refreshed

m_searchInbox

protected boolean m_searchInbox

Flag to indicate if provider should search for current user's inbox tasks only

m_includeTaskData

protected boolean m_includeTaskData

Flag that indicates if search result should include task business data

m_searchQuery

protected TaskSearchQueryV2 m_searchQuery

Task Search Query object

m_pageSizing

protected int m_pageSizing

Paging size

pagingService

protected TaskIndexedSearchContentProvider.TaskSearchPagingService pagingService

Instance of back end service which implement task search

m_NextResults

protected List<ITaskSearchRecord> m_NextResults

Stored current page results as list

m_results

protected ITask[] m_results

Current page results

taskDataClassName

protected String taskDataClassName

Stores task business data class name

Constructor Details

TaskIndexedSearchContentProvider

public TaskIndexedSearchContentProvider()

TaskIndexedSearchContentProvider

public TaskIndexedSearchContentProvider(TaskSearchQueryV2 searchQuery)

Constructor from task search query

Method Details

getSearchQuery

public TaskSearchQueryV2 getSearchQuery()

Returns task search query

isIncludeTaskData

public boolean isIncludeTaskData()

Returns flag if search results should include indexed task business data

setIncludeTaskData

public void setIncludeTaskData(boolean taskData)

Sets flag if search results should include indexed task business data

calculateRowId

protected String calculateRowId(int index,
 Object data)

Return data.getTaskInfo().getTaskID() as RowId

Overrides:

calculateRowId in class ListTableContentProvider

Parameters:

index - row index

data - row data object

Returns:

row id

getSearchInbox

public boolean getSearchInbox()

Description copied from interface: ITaskSearchContentProvider

Returns boolean value indicates whether to search current user inbox or full task list return true if search current user inbox only

Specified by:

getSearchInbox in interface ITaskSearchContentProvider

setSearchInbox

public void setSearchInbox(boolean value)

Description copied from interface: ITaskSearchContentProvider

Setting whether to search current user inbox or full task list

Specified by:

setSearchInbox in interface ITaskSearchContentProvider

getResults

public ITask[] getResults()
                   throws Exception

Returns results (task list) for the current page

Specified by:

getResults in interface ITaskSearchContentProvider

Returns:

array of task objects

Throws:

Exception

getNextResults

public List<ITaskSearchRecord> getNextResults()
                                       throws Exception

Returns results (task list) for the current page

Returns:

List of task objects

Throws:

Exception

getTaskInfo

public ITaskInfo getTaskInfo()

Returns ITaskInfo task info for the current row

Returns:

TaskInfo

refresh

public void refresh()
             throws ContentProviderException

Description copied from class: PageableTableContentProvider

Resets internal cache, rowCount and pageRowIndex. This will force the provider to call the paging service again when the client control requests first row.

Specified by:

refresh in interface IRefreshable

Overrides:

refresh in class PageableTableContentProvider

Throws:

ContentProviderException - if error loading data from the data source

hasSearchInvocation

protected boolean hasSearchInvocation()

Checks if provider is refreshed from the Search button invoke on the custom inbox page

Returns:

true if a search invocation has been triggered, false otherwise

refresh

public void refresh(boolean forSort)
             throws ContentProviderException

Refresh the content of the provider. This will search for tasks matching current search query.

Parameters:

forSort - true if this just resorting the previous data, false otherwise

Throws:

ContentProviderException

refreshPage

public void refreshPage()

This refreshes data for current provider page. This will search for tasks matching current search query

Overrides:

refreshPage in class PageableTableContentProvider

getTaskList

protected List<ITask> getTaskList(List<ITaskSearchRecord> searchRecords)

Helper method to convert task search records into list of ITask objects

Parameters:

searchRecords - list of task search records

Returns:

list of task objects

setPagingSize

public void setPagingSize(int count)

Sets page size for search

Specified by:

setPagingSize in interface ITaskSearchPagingContentProvider

Parameters:

page - size

getPagingSize

public int getPagingSize()

Returns page size used for search

Specified by:

getPagingSize in interface ITaskSearchPagingContentProvider

Returns:

page size

setTaskDataClassName

public void setTaskDataClassName(String className)

Sets task business data class name

Parameters:

className -

getTaskDataClassName

public String getTaskDataClassName()

Returns task business data class name

Returns:

task business data class name

supportsAutoRefresh

public boolean supportsAutoRefresh()

Description copied from class: SelectableListTableContentProvider

Returns false

Specified by:

supportsAutoRefresh in interface IRefreshable

Overrides:

supportsAutoRefresh in class SelectableListTableContentProvider

Returns:

true when auto refresh is supported

See Also:

• IRefreshable.setAutoRefresh(boolean)

setAutoRefresh

public void setAutoRefresh(boolean autoRefresh)
                    throws ContentProviderException

Description copied from interface: IRefreshable

Sets auto refresh mode on. When auto refresh mode is on, the provider calls IRefreshable.getNeedRefresh() to determine whether the refresh needs to be done before returning any result properties. If it returns true, the provider calls IRefreshable.refresh() method to updated the result properties.

Specified by:

setAutoRefresh in interface IRefreshable

Overrides:

setAutoRefresh in class SelectableListTableContentProvider

Parameters:

autoRefresh - true to turn it on

Throws:

ContentProviderException - if autorefresh is true

See Also:

• IRefreshable.supportsAutoRefresh()
• IRefreshable.getNeedRefresh()
• IRefreshable.setNeedRefresh(boolean)

isAutoRefresh

public boolean isAutoRefresh()

Description copied from class: SelectableListTableContentProvider

Returns false

Specified by:

isAutoRefresh in interface IRefreshable

Overrides:

isAutoRefresh in class SelectableListTableContentProvider

Returns:

false if auto-refresh mode is off or not supported

getNeedRefresh

public boolean getNeedRefresh()

Description copied from interface: IRefreshable

Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.

Implementations may return an accurate value from this method if they can track the changes to the input parameter properties or they may require the clients to call IRefreshable.setNeedRefresh(boolean) explicitely.

Specified by:

getNeedRefresh in interface IRefreshable

Overrides:

getNeedRefresh in class SelectableListTableContentProvider

Returns:

true when the output properties are not up-to-date with the current input parameters, i.e. IRefreshable.refresh() needs to be executed manually or automatically.

setNeedRefresh

public void setNeedRefresh(boolean needRefresh)

Description copied from interface: IRefreshable

Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).

Specified by:

setNeedRefresh in interface IRefreshable

Overrides:

setNeedRefresh in class SelectableListTableContentProvider

Parameters:

needRefresh - true if the input parameters have changed

getPropertyKeys

public Object[] getPropertyKeys()

Description copied from class: ListTableContentProvider

Returns property keys for the current row object which is an element of the wrapped array or the list by ListTableContentProvider.getRowIndex() index.

Specified by:

getPropertyKeys in interface IContentProvider

Overrides:

getPropertyKeys in class ListTableContentProvider

Returns:

array of String or Integer property keys

hasProperty

public boolean hasProperty(Object propertyKey)

Description copied from interface: IContentProvider

Checks if the given property is supported by this content provider

Specified by:

hasProperty in interface IContentProvider

Overrides:

hasProperty in class ListTableContentProvider

Parameters:

propertyKey - property key of type String or Integer

Returns:

true if property is supported

getValue

public Object getValue(Object propertyKey)
                throws ELException,
PropertyNotFoundException

Description copied from interface: IContentProvider

Returns value of the given property

Specified by:

getValue in interface IContentProvider

Overrides:

getValue in class ListTableContentProvider

Parameters:

propertyKey - the property key of type String or Integer

Returns:

value of the property, can be null

Throws:

PropertyNotFoundException - if property is not supported

ELException

getType

public Class<?> getType(Object propertyKey)
                 throws PropertyNotFoundException

Description copied from interface: IContentProvider

Returns java type of the given property

Specified by:

getType in interface IContentProvider

Overrides:

getType in class ListTableContentProvider

Parameters:

propertyKey - the property key of type String or Integer

Returns:

property java Class

Throws:

PropertyNotFoundException - if property is not supported

setSort

public void setSort(ISortInfo sort)

Description copied from interface: ISortableTableContentProvider

Sets new sort info, re-sorting the table (if necessary). This does not change the model's rowIndex property, even though it will probably now point to a different row.

Specified by:

setSort in interface ISortableTableContentProvider

Overrides:

setSort in class ListTableContentProvider

Parameters:

sort - Sort info, must not be null.

sort

protected void sort()

(Re-)sorts list according to sort info.

Overrides:

sort in class SelectableListTableContentProvider

See Also:

• setSort(ISortInfo)