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

Class BaseTaskSearchContentProvider

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.BaseTaskSearchContentProvider

All Implemented Interfaces:

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

public abstract class BaseTaskSearchContentProvider
extends SelectableListTableContentProvider
implements ITaskSearchContentProvider

BaseTaskSearchContentProvider is the abstract base implementation of ITaskSearchContentProvider.

See Also:

• ITaskSearchContentProvider
• Serialized Form

Nested Class Summary

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
protected boolean	m_isAutoRefresh
protected boolean	m_needRefresh
protected ITask[]	m_results
protected boolean	m_searchInbox
protected TaskSearchQuery	m_searchQuery
static final String	PROPERTY_TASKDATA	property key for task data

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
BaseTaskSearchContentProvider()	Default constructor.

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.
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 task search results
boolean	getSearchInbox()	Returns boolean value indicates whether to search current user inbox or full task list return true if search current user inbox only
TaskSearchQuery	getSearchQuery()	Returns task search query used for this provider
ITaskInfo	getTaskInfo()	Returns task info for current row as ITaskInfo
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
boolean	isAutoRefresh()	Returns false
void	setAutoRefresh(boolean autoRefresh)	Sets auto refresh mode on.
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	setSearchInbox(boolean value)	Setting whether to search current user inbox or full task list
boolean	supportsAutoRefresh()	Returns false

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

createRow, deleteRow, getCurrentRow, getList, getRowId, getRowSelectedCount, getRowSelectedIds, getRowUnselectedIds, getSelectedRows, getUseUnselectedModel, isAddressable, isRowSelected, moveTo, refresh, 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.IRefreshable

refresh

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

property key for task data

See Also:

• Constant Field Values

m_isAutoRefresh

protected boolean m_isAutoRefresh

m_needRefresh

protected boolean m_needRefresh

m_searchInbox

protected boolean m_searchInbox

m_includeTaskData

protected boolean m_includeTaskData

m_searchQuery

protected TaskSearchQuery m_searchQuery

m_results

protected ITask[] m_results

Constructor Details

BaseTaskSearchContentProvider

public BaseTaskSearchContentProvider()

Default constructor. Initialize search query field using default setting. Initialize row variable using default value. Set row id binding using the value binding from faces context if exists.

Method Details

getSearchQuery

public TaskSearchQuery getSearchQuery()

Returns task search query used for this provider

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 task search results

Specified by:

getResults in interface ITaskSearchContentProvider

Returns:

task list

Throws:

Exception

getTaskInfo

public ITaskInfo getTaskInfo()

Returns task info for current row as ITaskInfo

Returns:

task info

supportsAutoRefresh

public boolean supportsAutoRefresh()

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

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()

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()

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)

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()

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)

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

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

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

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