com.webmethods.caf.faces.data
Interface IAddressableTableContentProvider

All Superinterfaces:
IContentProvider, ITableContentProvider
All Known Subinterfaces:
ISelectableTableContentProvider, ISelectableTreeContentProvider, ITreeContentProvider, IUpdateableTableContentProvider
All Known Implementing Classes:
BaseIteratorTableContentProvider, BaseTaskSearchContentProvider, BoundChildrenTreeContentProvider, ChildrenTableContentProvider, CSPContentSearchProvider, DirectorySearchProvider, FilterableListTableContentProvider, FilterableListTreeContentProvider, FilterableSelectableListTableContentProvider, FilteredPortalContainerModel, LazyNodeTreeContentProvider, ListTableContentProvider, ListTreeContentProvider, NodeTreeContentProvider, PageableTableContentProvider, PeopleSearchProvider, PortalContainerModel, ProcessSearchProvider, RowSetTableContentProvider, SearchTableContentProvider, SelectableListTableContentProvider, TableTreeContentProvider, TaskAuditContentProvider, TaskInboxIndexedSearchContentProvider, TaskInboxSearchContentProvider, TaskIndexedSearchContentProvider, TaskSavedSearchContentProvider, TaskSearchContentProvider, VersionHistoryTableContentProvider, XMLTableContentProvider, XMLTreeContentProvider

public interface IAddressableTableContentProvider
extends ITableContentProvider

Table content provider with rows addressable by a unique String identifier. Implementations need to provide means to get identifier for each row.


Method Summary
 String getRowId()
          Returns unique identifier for the current row.
 boolean isAddressable()
          Checks if this content provider truly is addressable.
 void setRowById(String id)
          Selects current row by its id.
 
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

isAddressable

boolean isAddressable()
Checks if this content provider truly is addressable.

Returns:
true if addressable.

getRowId

String getRowId()
Returns unique identifier for the current row. If no current row is avaiable, returns null.

Returns:
current row id or null

setRowById

void setRowById(String id)
Selects current row by its id. If id doesn't identify a row, makes no row current (equivalent to setRowIndex(-1)).

Parameters:
id - row id to find and make current