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

Class TaskSavedSearchContentProvider

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

All Implemented Interfaces:

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

public class TaskSavedSearchContentProvider
extends TaskSearchContentProvider

Helper class that assists with management of Task Saved Searches

See Also:

• 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 Map<String,TaskSearchQueryTerm>	defaultQueryTermMap	Cached Map of default search terms
protected ISavedSearch	savedSearch	Represents saved search
protected PortalItemModel	savedSearchItem	Item representing saved search object as being stored inside MWS taxonomy
protected UserModel	userModel	Item representing current user

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

Method Summary

Modifier and Type	Method	Description
protected void	addQueryTerm(TaskSearchQuery searchQuery, Object value, TaskSearchQueryTerm taskSearchQueryTerm)	Adds query term to task search query
protected static TaskSearchQuery	applyUserSearchQueryTerm(TaskSearchQuery searchQuery, UserModel userModel)	Sets current principal to the task search query
TaskSearchQuery	createTaskSearchQuery(String savedSearchID)	Creates TaskSearchQuery from given savedSearchID
protected Map<String,TaskSearchQueryTerm>	getDefaultQueryTermMap()	Returns default map of search terms for inbox queries (task_field -> TaskSearchQueryTerm)
ISavedSearch	getSavedSearch()	Returns saved search object
PortalItemModel	getSavedSearchItem()	Returns item for saved search storage
UserModel	getUserModel()	Returns current user model
protected ISavedSearch	loadSavedSearch(PortalItemModel pim)	Loads save search object from storage object
protected TaskSearchQuery	loadSearchQuery(ISavedSearch savedSearch)	Creates TaskSearchQuery from saved search object
void	setSavedSearch(ISavedSearch savedSearch)	Sets saved search object
void	setSavedSearchID(String savedSearchID)	Sets ID of the saved search object.
void	setSavedSearchItem(PortalItemModel savedSearchItem)	Sets item for saved search storage
void	setUserModel(UserModel userModel)	Sets current user model.

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

calculateRowId, getNeedRefresh, getPropertyKeys, getResults, getResultsTotalCount, getSearchInbox, getSearchQuery, getTaskInfo, getTaskSearchQueryV2, getTotalCount, getType, getValue, hasProperty, isAutoRefresh, refresh, 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

defaultQueryTermMap

protected Map<String,TaskSearchQueryTerm> defaultQueryTermMap

Cached Map of default search terms

savedSearchItem

protected PortalItemModel savedSearchItem

Item representing saved search object as being stored inside MWS taxonomy

userModel

protected UserModel userModel

Item representing current user

savedSearch

protected ISavedSearch savedSearch

Represents saved search

Constructor Details

TaskSavedSearchContentProvider

public TaskSavedSearchContentProvider()

Method Details

setSavedSearchID

public void setSavedSearchID(String savedSearchID)
                      throws Exception

Sets ID of the saved search object. This is a string value or alias of the object stored inside MWS taxonomy which represents saved search

Throws:

Exception

getSavedSearchItem

public PortalItemModel getSavedSearchItem()

Returns item for saved search storage

setSavedSearchItem

public void setSavedSearchItem(PortalItemModel savedSearchItem)
                        throws Exception

Sets item for saved search storage

Throws:

Exception

getUserModel

public UserModel getUserModel()

Returns current user model

setUserModel

public void setUserModel(UserModel userModel)

Sets current user model.

getSavedSearch

public ISavedSearch getSavedSearch()

Returns saved search object

setSavedSearch

public void setSavedSearch(ISavedSearch savedSearch)

Sets saved search object

createTaskSearchQuery

public TaskSearchQuery createTaskSearchQuery(String savedSearchID)
                                      throws Exception

Creates TaskSearchQuery from given savedSearchID

Parameters:

savedSearchID - saved search storage object ID

Throws:

Exception

loadSearchQuery

protected TaskSearchQuery loadSearchQuery(ISavedSearch savedSearch)
                                   throws Exception

Creates TaskSearchQuery from saved search object

Parameters:

savedSearch - Saved Search object

Throws:

Exception

applyUserSearchQueryTerm

protected static TaskSearchQuery applyUserSearchQueryTerm(TaskSearchQuery searchQuery,
 UserModel userModel)

Sets current principal to the task search query

Parameters:

searchQuery - task search query to set user on

userModel - user model for current user

Returns:

same task search query

loadSavedSearch

protected ISavedSearch loadSavedSearch(PortalItemModel pim)
                                throws Exception

Loads save search object from storage object

Parameters:

pim - storage object for saved search

Returns:

saved search instance

Throws:

Exception

addQueryTerm

protected void addQueryTerm(TaskSearchQuery searchQuery,
 Object value,
 TaskSearchQueryTerm taskSearchQueryTerm)

Adds query term to task search query

Parameters:

searchQuery - task search query to add term to

value - search value

taskSearchQueryTerm - term which defines search operator and searchable fields

getDefaultQueryTermMap

protected Map<String,TaskSearchQueryTerm> getDefaultQueryTermMap()

Returns default map of search terms for inbox queries (task_field -> TaskSearchQueryTerm)