com.webmethods.caf.faces.data

Interface ISelectableTableContentProvider

All Superinterfaces:

IAddressableTableContentProvider, IContentProvider, ITableContentProvider

All Known Subinterfaces:

ISelectableTreeContentProvider

All Known Implementing Classes:

BaseIteratorTableContentProvider, BaseTaskSearchContentProvider, BoundChildrenTreeContentProvider, ChildrenTableContentProvider, CustomTaskSearchContentProvider, DirectorySearchProvider, FilterableListTreeContentProvider, FilterableSelectableListTableContentProvider, FilteredPortalContainerModel, GMarkerGroupTableContentProvider, LazyNodeTreeContentProvider, ListTreeContentProvider, NodeTreeContentProvider, PageableTableContentProvider, PeopleSearchProvider, PortalContainerModel, ProcessSearchProvider, RowSetTableContentProvider, SearchTableContentProvider, SelectableListTableContentProvider, TableTreeContentProvider, TaskInboxHpstraSearchContentProvider, TaskInboxIndexedSearchContentProvider, TaskInboxSearchContentProvider, TaskIndexedSearchContentProvider, TaskSavedSearchContentProvider, TaskSearchContentProvider, VersionHistoryTableContentProvider, XMLTableContentProvider, XMLTreeContentProvider

public interface ISelectableTableContentProvider
extends IAddressableTableContentProvider

Table content provider that supports selecting individual rows by leveraging ability of identifying and addressing rows by id from <@link com.webmethods.caf.faces.data.IAddressableTableContentProvider}

Method Summary

Modifier and Type	Method and Description
int	getRowSelectedCount() Returns number of selected rows.
Collection	getRowSelectedIds() Returns collection of String ids of the selected rows.
Collection	getRowUnselectedIds() Returns collection of String ids of the un-selected rows (all other rows are selected implicitly) May be empty or contain non-existent ids; never null, never contains null.
boolean	getUseUnselectedModel() Returns true if it's more effecient to use unselected model (ie getRowUnselectedIds() rather than getRowSelectedIds()).
boolean	isRowSelected() Returns true if current row is selected.
void	setRowSelected(boolean selected) Sets the selection status for the current row.
void	setRowSelectedIds(Collection ids) Sets new selection using a collection of String ids of the rows to select.
void	setRowUnselectedIds(Collection ids) Unselects rows using a collection of String ids of the un-selected rows (all other rows are selected implicitly).

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

getRowId, isAddressable, setRowById

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

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

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

getPropertyKeys, getType, getValue, hasProperty, toString

Method Detail

isRowSelected

boolean isRowSelected()

Returns true if current row is selected.

Returns:

true if current row is selection

setRowSelected

void setRowSelected(boolean selected)

Sets the selection status for the current row.

Parameters:

selected - true to select current row; false to unselect.

getRowSelectedCount

int getRowSelectedCount()

Returns number of selected rows.

Returns:

number of currently selection rows

getRowSelectedIds

Collection getRowSelectedIds()

Returns collection of String ids of the selected rows. May be empty or contain non-existent ids; never null, never contains null.

Returns:

collection of ids of selected rows

setRowSelectedIds

void setRowSelectedIds(Collection ids)

Sets new selection using a collection of String ids of the rows to select. May be empty or contain non-existent ids; never null, never contains null.

Parameters:

ids - the collection of String row ids

getUseUnselectedModel

boolean getUseUnselectedModel()

Returns true if it's more effecient to use unselected model (ie getRowUnselectedIds() rather than getRowSelectedIds()).

Returns:

true if it's more effecient to use unselected model

getRowUnselectedIds

Collection getRowUnselectedIds()

Returns collection of String ids of the un-selected rows (all other rows are selected implicitly) May be empty or contain non-existent ids; never null, never contains null.

Returns:

collection of ids of the un-selection rows

setRowUnselectedIds

void setRowUnselectedIds(Collection ids)

Unselects rows using a collection of String ids of the un-selected rows (all other rows are selected implicitly). May be empty or contain non-existent ids; never null, never contains null.

Parameters:

ids - collection of String row ids