com.webmethods.caf.faces.data.portal
Class PortalContainerModel

java.lang.Object
  extended by com.webmethods.caf.faces.bean.PageFlowScopeAdapter
      extended by com.webmethods.caf.faces.data.object.ListTableContentProvider
          extended by com.webmethods.caf.faces.data.object.SelectableListTableContentProvider
              extended by com.webmethods.caf.faces.data.object.PageableTableContentProvider
                  extended by com.webmethods.caf.faces.data.portal.PortalContainerModel
All Implemented Interfaces:
IPageFlowScopeAdapter, IAddressableTableContentProvider, IContentProvider, IPageableTableContentProvider, IRefreshable, IRefreshableContentProvider, IReorderableTableContentProvider, ISelectableTableContentProvider, ISortableTableContentProvider, ITableContentProvider, IUpdateableContentProvider, IUpdateableTableContentProvider, Serializable
Direct Known Subclasses:
FilteredPortalContainerModel

Deprecated. Use JCR providers instead

public class PortalContainerModel
extends PageableTableContentProvider

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
static int DEFAULT_PAGE_SIZE
          Deprecated.  
protected  String m_containerID
          Deprecated.  
protected  boolean m_isAutoRefresh
          Deprecated.  
protected  boolean m_needRefresh
          Deprecated.  
static String ROW_VARIABLE
          Deprecated.  
 
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
PortalContainerModel()
          Deprecated.  
 
Method Summary
protected  String calculateRowId(int index, Object data)
          Deprecated. Calculates row id from the row data object using ListTableContentProvider.getRowIdBinding() expression.
protected  String calculateRowId(Object item)
          Deprecated.  
protected  PortalItemModel createItemModel(IThingID thingID)
          Deprecated. Create the model object for the requested thing
 String getContainerID()
          Deprecated.  
 PortalItemModel getItem()
          Deprecated.  
 boolean getNeedRefresh()
          Deprecated. Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.
static IURI getURI(String id)
          Deprecated.  
 boolean isAutoRefresh()
          Deprecated. Returns false
protected  void refreshPage()
          Deprecated. Refreshes the associated page data provider.
 void setAutoRefresh(boolean autoRefresh)
          Deprecated. Sets auto refresh mode on.
 void setContainerID(String containerID)
          Deprecated.  
 void setNeedRefresh(boolean needRefresh)
          Deprecated. 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).
 String toString()
          Deprecated. Returns string representation of content.
 
Methods inherited from class com.webmethods.caf.faces.data.object.PageableTableContentProvider
getArray, getList, getPageRowIndex, getRefreshPageBinding, getRowCount, getTable, isRowAvailable, loadPageData, refresh, setArray, setList, setPageRowIndex, setRefreshPageBinding, 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, sort, supportsAutoRefresh, updateOriginalList
 
Methods inherited from class com.webmethods.caf.faces.data.object.ListTableContentProvider
getCanTemplateRow, getOnCreateRow, getOnDeleteRow, getPropertyKeys, getRowIdBinding, getRowIndex, getRowType, getRowVariable, getSort, getType, getValue, hasProperty, isReadOnly, isReorderable, isTemplateRow, newRow, setCanTemplateRow, setOnCreateRow, setOnDeleteRow, setRowId, setRowIdBinding, setRowIndex, setRowType, setSort, setValue
 
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.ITableContentProvider
getCurrentRow, getRowIndex, getRowVariable, setRowIndex, setRowVariable
 
Methods inherited from interface com.webmethods.caf.faces.data.IContentProvider
getPropertyKeys, getType, getValue, hasProperty
 

Field Detail

ROW_VARIABLE

public static final String ROW_VARIABLE
Deprecated. 
See Also:
Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE
Deprecated. 
See Also:
Constant Field Values

m_isAutoRefresh

protected boolean m_isAutoRefresh
Deprecated. 

m_needRefresh

protected boolean m_needRefresh
Deprecated. 

m_containerID

protected String m_containerID
Deprecated. 
Constructor Detail

PortalContainerModel

public PortalContainerModel()
Deprecated. 
Method Detail

getContainerID

public String getContainerID()
Deprecated. 

setContainerID

public void setContainerID(String containerID)
Deprecated. 

getItem

public PortalItemModel getItem()
Deprecated. 

calculateRowId

protected String calculateRowId(Object item)
Deprecated. 
Overrides:
calculateRowId in class ListTableContentProvider
Parameters:
item - row data object
Returns:
row id

calculateRowId

protected String calculateRowId(int index,
                                Object data)
Deprecated. 
Description copied from class: ListTableContentProvider
Calculates row id from the row data object using ListTableContentProvider.getRowIdBinding() expression.

Overrides:
calculateRowId in class ListTableContentProvider
Parameters:
index - row index
data - row data object
Returns:
row id

getNeedRefresh

public boolean getNeedRefresh()
Deprecated. 
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.

isAutoRefresh

public boolean isAutoRefresh()
Deprecated. 
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

setAutoRefresh

public void setAutoRefresh(boolean autoRefresh)
                    throws ContentProviderException
Deprecated. 
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)

setNeedRefresh

public void setNeedRefresh(boolean needRefresh)
Deprecated. 
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

refreshPage

protected void refreshPage()
Deprecated. 
Description copied from class: PageableTableContentProvider
Refreshes the associated page data provider. The typical implementation is to assign paging service input parameters based on pageRowIndex, call the service and reassign return data back. Return data may be array, list or table provider and may define rowCount as well. Default implemention calls PageableTableContentProvider.getRefreshPageBinding() method if not null

Overrides:
refreshPage in class PageableTableContentProvider

createItemModel

protected PortalItemModel createItemModel(IThingID thingID)
Deprecated. 
Create the model object for the requested thing

Parameters:
thingID - the id of the item
Returns:
item model object

getURI

public static IURI getURI(String id)
                   throws ContentProviderException
Deprecated. 
Throws:
ContentProviderException

toString

public String toString()
Deprecated. 
Description copied from interface: IContentProvider
Returns string representation of content.

Specified by:
toString in interface IContentProvider
Overrides:
toString in class ListTableContentProvider
Returns:
String representation of the wrapped content